latestOpenAPI 3.0.22026-08-086314226.2 KB

f5e3ea16a648

Locations

get/locations

Query parameters

limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

is_archivedstring

is_archived

created_beforestring

created_before

created_afterstring

created_after

orderingstring

Which field to use when ordering the results.

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}