Skip to main content
GET
/
v1
/
organizations
List Organizations
curl --request GET \
  --url https://api.aspect-dev.systems/v1/organizations \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "type": "organizations",
      "attributes": {
        "id": "<string>",
        "name": "<string>",
        "timezone": "<string>",
        "region": "AB",
        "country": "CA"
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "path": "<string>",
    "per_page": 123,
    "next_cursor": "<string>",
    "prev_cursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[size]
integer
default:30

The number of results that will be returned per page.

page[cursor]
string

The cursor to start the pagination from.

Response

200 - application/vnd.api+json

Paginated set of OrganizationResource

data
OrganizationResource · object[]
required
meta
object
required