Menu
Documentationbreadcrumb arrow OnCallbreadcrumb arrow API referencebreadcrumb arrow Grafana OnCall organizations HTTP API
Open source

Grafana OnCall organizations HTTP API

Get an organization

This endpoint retrieves the organization object.

shell
curl "{{API_URL}}/api/v1/organizations/O53AAGWFBPE5W/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured in the following way:

json
{
  "id": "O53AAGWFBPE5W"
}

HTTP request

GET {{API_URL}}/api/v1/organizations/<ORGANIZATION_ID>/

ParameterUniqueDescription
idYesOrganization ID

List Organizations

shell
curl "{{API_URL}}/api/v1/organizations/" \
  --request GET \
  --header "Authorization: meowmeowmeow" \
  --header "Content-Type: application/json"

The above command returns JSON structured in the following way:

json
{
  "count": 1,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "O53AAGWFBPE5W"
    }
  ],
  "page_size": 25,
  "current_page_number": 1,
  "total_pages": 1
}

Note: The response is paginated. You may need to make multiple requests to get all records.

HTTP request

GET {{API_URL}}/api/v1/organizations/