update public API docs subpage ordering (#4833 )

# What this PR does

**Before**
![Screenshot 2024-08-15 at 13 55
40](https://github.com/user-attachments/assets/847afb34-d8d1-46f8-b6b4-fba2b6a469e0)

**After**
<img width="295" alt="Screenshot 2024-08-15 at 15 20 41"
src="https://github.com/user-attachments/assets/6cfef429-fde6-4b0d-81af-f59e97adaaaa">

2024-08-15 19:29:56 +00:00

1.8 KiB

Raw Blame History

canonical

title

weight

refs

https://grafana.com/docs/oncall/latest/oncall-api-reference/organizations/

Grafana OnCall organizations HTTP API

pagination

pattern	destination
/docs/oncall/	/docs/oncall/<ONCALL_VERSION>/oncall-api-reference/#pagination

pattern	destination
/docs/grafana-cloud/	/docs/grafana-cloud/alerting-and-irm/oncall/oncall-api-reference/#pagination

Grafana OnCall organizations HTTP API

Get an organization

This endpoint retrieves the organization object.

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:

{
  "id": "O53AAGWFBPE5W"
}

HTTP request

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

Parameter	Unique	Description
`id`	Yes	Organization ID

List Organizations

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:

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

1.8 KiB Raw Blame History

Grafana OnCall organizations HTTP API

Get an organization

List Organizations

1.8 KiB

Raw Blame History