Skip to main content
GET
/
v1
/
organizations
List organizations
curl --request GET \
  --url https://api.chataigne.ai/v1/organizations \
  --header 'x-api-key: <api-key>'
{
  "object": "list",
  "data": [
    {
      "id": "org_02d224786a994d37a7e8a731",
      "object": "organization",
      "name": "Pokawa",
      "location_ids": [
        "loc_023d6847de544fdb9a5510db"
      ],
      "active_location_ids": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "locations": [
        {
          "id": "loc_023d6847de544fdb9a5510db",
          "object": "location",
          "organization_id": "<string>",
          "name": "Pokawa Châtelet",
          "currency": "EUR",
          "country": "FR",
          "timezone": "Europe/Paris",
          "default_language": "fr",
          "address": {
            "line1": "<string>",
            "line2": "<string>",
            "postal_code": "<string>",
            "city": "<string>",
            "country": "<string>",
            "latitude": 123,
            "longitude": 123
          },
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ],
  "has_more": true,
  "url": "<string>"
}

Authorizations

x-api-key
string
header
required

Location/organization API key.

Query Parameters

limit
integer
default:10

Page size (1–100).

Required range: 1 <= x <= 100
starting_after
string

Cursor: return results after this id.

ending_before
string

Cursor: return results before this id.

created_after
string<date-time>

Only resources created strictly after this time.

created_before
string<date-time>

Only resources created strictly before this time.

updated_after
string<date-time>

Only resources updated strictly after this time.

updated_before
string<date-time>

Only resources updated strictly before this time.

Response

A paginated list of organizations.

object
enum<string>
Available options:
list
data
object[]
has_more
boolean
url
string