DocsDocsReference

List all organizations

Retrieves a paginated list of organizations with comprehensive filtering options including search, status, country, credit check status, custom attributes, and date ranges. Supports sorting and pagination.

GET/api/v1/{team_slug}/{app_slug}/organisations
API
Management
Updated
Apr 26, 2026

management-api:GET:/api/v1/{team_slug}/{app_slug}/organisations

Retrieves a paginated list of organizations with comprehensive filtering options including search, status, country, credit check status, custom attributes, and date ranges. Supports sorting and pagination.

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations
  • Summary: List all organizations
  • Description: Retrieves a paginated list of organizations with comprehensive filtering options including search, status, country, credit check status, custom attributes, and date ranges. Supports sorting and pagination.
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters16 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
pagequeryNointegerPage number (default: 1)
per-pagequeryNointegerItems per page (default: 20, max: 100)
sort-keyqueryNostringSort field (name, organisation_number, created_at, updated_at, status)
sort-orderqueryNostringSort direction (asc, desc, default: desc)
searchqueryNostringSearch term
has-merchant-usersqueryNobooleanFilter organizations that have merchant users
statusqueryNostringFilter by status (comma-separated: active, pending, inactive)
countryqueryNostringFilter by country code from company addresses (comma-separated, e.g., 'SE,NO')
credit-checkqueryNobooleanFilter by credit check status
attributesqueryNostringFilter by attributes (comma-separated template_key/attr_key pairs, ALL must match, e.g., 'color/red,size/large')
created-at-beforequeryNostringFilter organizations created before this date (YYYY-MM-DD format, e.g., 2025-11-20)
created-at-afterqueryNostringFilter organizations created after this date (YYYY-MM-DD format, e.g., 2025-11-20)
updated-at-beforequeryNostringFilter organizations updated before this date (YYYY-MM-DD format, e.g., 2025-11-20)
updated-at-afterqueryNostringFilter organizations updated after this date (YYYY-MM-DD format, e.g., 2025-11-20)
Request bodyNo documented body

Not documented in the OpenAPI contract.

Responses4 statuses
StatusDescriptionContent
200List of organizationsapplication/json (object)
400Invalid request (e.g. bad parameters, validation error)application/json (object)
401Unauthorized accessapplication/json (object)
500Internal server errorapplication/json (object)

200 - object

Organisation List Item List

PropertyTypeRequiredDetails
dataobject[]No-
successbooleanNo-
totalintegerNo-
total_pagesintegerNo-
Organisation List Item
PropertyTypeRequiredDetails
app_idstringNo-
attributesobject[]No-
billing_addressobject[]No-
commentstringNo-
contact_namestringNo-
created_atstringNo-
credit_checkbooleanNo-
custom_fieldsobjectNo-
customer_groupsobject[]No-
emailstringNo-
external_refstringNo-
idstringNo-
invoice_emailstringNo-
namestringNo-
organisation_numberstringNo-
parent_idstringNo-
parentsobject[]No-
phonestringNo-
shipping_addressobject[]No-
statusstringNo-
tagsobject[]No-
tax_id_vat_numberstringNo-
updated_atstringNo-
Attribute
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
template_keystringNo-
template_namestringNo-
translatablebooleanNo-
translationsobjectNo-
updated_atstringNo-
valuesobjectNo-
Organisation Address
PropertyTypeRequiredDetails
citystringNo-
co_addressstringNo-
company_idstringNo-
company_namestringNo-
countrystringNo-
created_atstringNo-
house_numberstringNo-
idstringNo-
is_defaultbooleanNo-
namestringNo-
phonestringNo-
postal_codestringNo-
state_provincestringNo-
street_addressstringNo-
updated_atstringNo-
Customer Group Ref
PropertyTypeRequiredDetails
idstringNo-
namestringNo-
slugstringNo-
Organisation Parent
PropertyTypeRequiredDetails
idstringNo-
namestringNo-
organisation_numberstringNo-
Tag
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
marketsobject[]No-
namestringNo-
schedulesobject[]No-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
translationsobjectNo-
updated_atstringNo-
{
  "data": [
    {
      "app_id": "string",
      "attributes": [
        {
          "created_at": null,
          "description": null,
          "filterable": null,
          "id": null,
          "key": null,
          "name": null,
          "template_key": null,
          "template_name": null,
          "translatable": null,
          "translations": null,
          "updated_at": null,
          "values": null
        }
      ],
      "billing_address": [
        {
          "city": null,
          "co_address": null,
          "company_id": null,
          "company_name": null,
          "country": null,
          "created_at": null,
          "house_number": null,
          "id": null,
          "is_default": null,
          "name": null,
          "phone": null,
          "postal_code": null,
          "state_province": null,
          "street_address": null,
          "updated_at": null
        }
      ],
      "comment": "string",
      "contact_name": "string",
      "created_at": "string",
      "credit_check": false,
      "custom_fields": {},
      "customer_groups": [
        {
          "id": null,
          "name": null,
          "slug": null
        }
      ],
      "email": "string",
      "external_ref": "string",
      "id": "string",
      "invoice_email": "string",
      "name": "string",
      "organisation_number": "string",
      "parent_id": "string",
      "parents": [
        {
          "id": null,
          "name": null,
          "organisation_number": null
        }
      ],
      "phone": "string",
      "shipping_address": [
        {
          "city": null,
          "co_address": null,
          "company_id": null,
          "company_name": null,
          "country": null,
          "created_at": null,
          "house_number": null,
          "id": null,
          "is_default": null,
          "name": null,
          "phone": null,
          "postal_code": null,
          "state_province": null,
          "street_address": null,
          "updated_at": null
        }
      ],
      "status": "string",
      "tags": [
        {
          "attributes": null,
          "created_at": null,
          "filterable": null,
          "id": null,
          "key": null,
          "markets": null,
          "name": null,
          "schedules": null,
          "source_app_id": null,
          "source_id": null,
          "status": null,
          "translations": null,
          "updated_at": null
        }
      ],
      "tax_id_vat_number": "string",
      "updated_at": "string"
    }
  ],
  "success": false,
  "total": 0,
  "total_pages": 0
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": false
}

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: GET
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/organisations
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Organizations
  • OpenAPI summary: List all organizations

List all organizations

# List all organizations Retrieves a paginated list of organizations with comprehensive filtering options including search, status, country, credit check status, custom attributes, and date ranges. Supports sorting and pagination.
GET /api/v1/{team_slug}/{app_slug}/organisations
Purpose

Retrieves a paginated list of organizations with comprehensive filtering options including search, status, country, credit check status, custom attributes, and date ranges.

Required inputs

app_slug path team_slug path

Primary response

200 ยท List of organizations

Operation key

management-api:GET:/api/v1/{team_slug}/{app_slug}/organisations

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/organisations` - Summary: List all organizations - Description: Retrieves a paginated list of organizations with comprehensive filtering options including search, status, country, credit check status, custom attributes, and date ranges. Supports sorting and pagination. - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/organisations` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | | page | query | No | integer | Page number (default: 1) | | per-page | query | No | integer | Items per page (default: 20, max: 100) | | sort-key | query | No | string | Sort field (name, organisation_number, created_at, updated_at, status) | | sort-order | query | No | string | Sort direction (asc, desc, default: desc) | | search | query | No | string | Search term | | has-merchant-users | query | No | boolean | Filter organizations that have merchant users | | status | query | No | string | Filter by status (comma-separated: active, pending, inactive) | | country | query | No | string | Filter by country code from company addresses (comma-separated, e.g., 'SE,NO') | | credit-check | query | No | boolean | Filter by credit check status | | attributes | query | No | string | Filter by attributes (comma-separated template_key/attr_key pairs, ALL must match, e.g., 'color/red,size/large') | | created-at-before | query | No | string | Filter organizations created before this date (YYYY-MM-DD format, e.g., 2025-11-20) | | created-at-after | query | No | string | Filter organizations created after this date (YYYY-MM-DD format, e.g., 2025-11-20) | | updated-at-before | query | No | string | Filter organizations updated before this date (YYYY-MM-DD format, e.g., 2025-11-20) | | updated-at-after | query | No | string | Filter organizations updated after this date (YYYY-MM-DD format, e.g., 2025-11-20) | ## Request body Not documented in the OpenAPI contract. ## Responses | Status | Description | Content | | --- | --- | --- | | 200 | List of organizations | application/json (object) | | 400 | Invalid request (e.g. bad parameters, validation error) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 500 | Internal server error | application/json (object) | ### 200 - object #### Organisation List Item List | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | No | - | | `success` | boolean | No | - | | `total` | integer | No | - | | `total_pages` | integer | No | - | ##### Organisation List Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `app_id` | string | No | - | | `attributes` | object[] | No | - | | `billing_address` | object[] | No | - | | `comment` | string | No | - | | `contact_name` | string | No | - | | `created_at` | string | No | - | | `credit_check` | boolean | No | - | | `custom_fields` | object | No | - | | `customer_groups` | object[] | No | - | | `email` | string | No | - | | `external_ref` | string | No | - | | `id` | string | No | - | | `invoice_email` | string | No | - | | `name` | string | No | - | | `organisation_number` | string | No | - | | `parent_id` | string | No | - | | `parents` | object[] | No | - | | `phone` | string | No | - | | `shipping_address` | object[] | No | - | | `status` | string | No | - | | `tags` | object[] | No | - | | `tax_id_vat_number` | string | No | - | | `updated_at` | string | No | - | ##### Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `translatable` | boolean | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `values` | object | No | - | ##### Organisation Address | Property | Type | Required | Details | | --- | --- | --- | --- | | `city` | string | No | - | | `co_address` | string | No | - | | `company_id` | string | No | - | | `company_name` | string | No | - | | `country` | string | No | - | | `created_at` | string | No | - | | `house_number` | string | No | - | | `id` | string | No | - | | `is_default` | boolean | No | - | | `name` | string | No | - | | `phone` | string | No | - | | `postal_code` | string | No | - | | `state_province` | string | No | - | | `street_address` | string | No | - | | `updated_at` | string | No | - | ##### Customer Group Ref | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `name` | string | No | - | | `slug` | string | No | - | ##### Organisation Parent | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `name` | string | No | - | | `organisation_number` | string | No | - | ##### Tag | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `markets` | object[] | No | - | | `name` | string | No | - | | `schedules` | object[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - |
Generated example (synthetic) ```json { "data": [ { "app_id": "string", "attributes": [ { "created_at": null, "description": null, "filterable": null, "id": null, "key": null, "name": null, "template_key": null, "template_name": null, "translatable": null, "translations": null, "updated_at": null, "values": null } ], "billing_address": [ { "city": null, "co_address": null, "company_id": null, "company_name": null, "country": null, "created_at": null, "house_number": null, "id": null, "is_default": null, "name": null, "phone": null, "postal_code": null, "state_province": null, "street_address": null, "updated_at": null } ], "comment": "string", "contact_name": "string", "created_at": "string", "credit_check": false, "custom_fields": {}, "customer_groups": [ { "id": null, "name": null, "slug": null } ], "email": "string", "external_ref": "string", "id": "string", "invoice_email": "string", "name": "string", "organisation_number": "string", "parent_id": "string", "parents": [ { "id": null, "name": null, "organisation_number": null } ], "phone": "string", "shipping_address": [ { "city": null, "co_address": null, "company_id": null, "company_name": null, "country": null, "created_at": null, "house_number": null, "id": null, "is_default": null, "name": null, "phone": null, "postal_code": null, "state_province": null, "street_address": null, "updated_at": null } ], "status": "string", "tags": [ { "attributes": null, "created_at": null, "filterable": null, "id": null, "key": null, "markets": null, "name": null, "schedules": null, "source_app_id": null, "source_id": null, "status": null, "translations": null, "updated_at": null } ], "tax_id_vat_number": "string", "updated_at": "string" } ], "success": false, "total": 0, "total_pages": 0 } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `GET` - Path: `/api/v1/{team_slug}/{app_slug}/organisations` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:GET:/api/v1/{team_slug}/{app_slug}/organisations` - OpenAPI tag: Organizations - OpenAPI summary: List all organizations