Skip to main content
GET
/
api
/
v1
/
{team_slug}
/
{app_slug}
/
organisations
Error
A valid request URL is required to generate request examples
{
  "data": [
    {
      "app_id": "<string>",
      "attributes": [
        {
          "created_at": "<string>",
          "description": "<string>",
          "filterable": true,
          "id": "<string>",
          "key": "<string>",
          "name": "<string>",
          "template_key": "<string>",
          "template_name": "<string>",
          "translatable": true,
          "translations": {
            "description": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ],
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>",
          "values": {}
        }
      ],
      "billing_address": [
        {
          "city": "<string>",
          "co_address": "<string>",
          "company_id": "<string>",
          "company_name": "<string>",
          "country": "<string>",
          "created_at": "<string>",
          "house_number": "<string>",
          "id": "<string>",
          "is_default": true,
          "name": "<string>",
          "phone": "<string>",
          "postal_code": "<string>",
          "state_province": "<string>",
          "street_address": "<string>",
          "updated_at": "<string>"
        }
      ],
      "comment": "<string>",
      "contact_name": "<string>",
      "created_at": "<string>",
      "credit_check": true,
      "custom_fields": {},
      "email": "<string>",
      "external_ref": "<string>",
      "id": "<string>",
      "invoice_email": "<string>",
      "name": "<string>",
      "organisation_number": "<string>",
      "phone": "<string>",
      "shipping_address": [
        {
          "city": "<string>",
          "co_address": "<string>",
          "company_id": "<string>",
          "company_name": "<string>",
          "country": "<string>",
          "created_at": "<string>",
          "house_number": "<string>",
          "id": "<string>",
          "is_default": true,
          "name": "<string>",
          "phone": "<string>",
          "postal_code": "<string>",
          "state_province": "<string>",
          "street_address": "<string>",
          "updated_at": "<string>"
        }
      ],
      "status": "<string>",
      "tags": [
        {
          "attributes": [
            {
              "created_at": "<string>",
              "description": "<string>",
              "filterable": true,
              "id": "<string>",
              "key": "<string>",
              "name": "<string>",
              "template_key": "<string>",
              "template_name": "<string>",
              "translatable": true,
              "translations": {
                "description": [
                  {
                    "id": "<string>",
                    "locale": "<string>",
                    "omni_channel_translations": [
                      {
                        "id": "<string>",
                        "market_id": "<string>",
                        "store_group_id": "<string>",
                        "value": "<string>"
                      }
                    ],
                    "value": "<string>"
                  }
                ],
                "name": [
                  {
                    "id": "<string>",
                    "locale": "<string>",
                    "omni_channel_translations": [
                      {
                        "id": "<string>",
                        "market_id": "<string>",
                        "store_group_id": "<string>",
                        "value": "<string>"
                      }
                    ],
                    "value": "<string>"
                  }
                ]
              },
              "updated_at": "<string>",
              "values": {}
            }
          ],
          "created_at": "<string>",
          "filterable": true,
          "id": "<string>",
          "key": "<string>",
          "markets": [
            {
              "active": true,
              "country_codes": [
                "<string>"
              ],
              "created_at": "<string>",
              "currency_code": "<string>",
              "id": "<string>",
              "locale": "<string>",
              "name": "<string>",
              "slug": "<string>",
              "updated_at": "<string>"
            }
          ],
          "name": "<string>",
          "schedules": [
            {
              "execute_at": "<string>",
              "finished_at": "<string>",
              "id": "<string>",
              "item_id": "<string>",
              "item_type": "<string>",
              "to_amount_cents_with_tax": 123,
              "to_on_sale": true,
              "to_sale_amount_cents_with_tax": 123,
              "to_status": "<string>"
            }
          ],
          "status": "<string>",
          "translations": {
            "name": [
              {
                "id": "<string>",
                "locale": "<string>",
                "omni_channel_translations": [
                  {
                    "id": "<string>",
                    "market_id": "<string>",
                    "store_group_id": "<string>",
                    "value": "<string>"
                  }
                ],
                "value": "<string>"
              }
            ]
          },
          "updated_at": "<string>"
        }
      ],
      "tax_id_vat_number": "<string>",
      "updated_at": "<string>"
    }
  ],
  "success": true,
  "total": 123,
  "total_pages": 123
}

Path Parameters

​
app_slug
string
required

App slug

​
team_slug
string
required

Team slug

Query Parameters

​
page
integer

Page number (default: 1)

​
per-page
integer

Items per page (default: 20, max: 100)

​
sort-key
string

Sort field (name, organisation_number, created_at, updated_at, status)

​
sort-order
string

Sort direction (asc, desc, default: desc)

​
search
string

Search term

​
has-merchant-users
boolean

Filter organizations that have merchant users

​
status
string

Filter by status (comma-separated: active, pending, inactive)

​
credit-check
boolean

Filter by credit check status

​
attribute-ids
string

Filter by attribute IDs (comma-separated UUIDs, ALL must match)

​
created-at-before
string

Filter organizations created before this date (YYYY-MM-DD format, e.g., 2025-11-20)

​
created-at-after
string

Filter organizations created after this date (YYYY-MM-DD format, e.g., 2025-11-20)

​
updated-at-before
string

Filter organizations updated before this date (YYYY-MM-DD format, e.g., 2025-11-20)

​
updated-at-after
string

Filter organizations updated after this date (YYYY-MM-DD format, e.g., 2025-11-20)

Response

List of organizations

​
data
object[]
​
success
boolean
​
total
integer
​
total_pages
integer