Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentation OnCall API reference Grafana OnCall organizations HTTP API

Grafana OnCall organizations HTTP API

Get an organization

This endpoint retrieves the organization object.

shell Copy

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 Copy

{
  "id": "O53AAGWFBPE5W"
}

HTTP request

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

List Organizations

shell Copy

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 Copy

{
  "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/