Sign in
Organization

List organizations

Retrieve all organization objects.

get/api/v1/organizations

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger

Filter by organization ID.

namestring

Filter by organization name.

active_tokenstring

Filter by active token. Indicates what organization does the active token belong to.

include_membership_organizationsboolean

Include organizations that user is either in or is connected to through membership.

ordering'id' | '-id' | 'name' | '-name'

Result ordering.

Response

OK

Example response

{
  "results": [
    {
      "id": 406,
      "name": "East West Trading Co",
      "url": "https://example.rossum.app/api/v1/organizations/406",
      "workspaces": [
        "https://example.rossum.app/api/v1/workspaces/7540"
      ],
      "users": [
        "https://example.rossum.app/api/v1/users/10775"
      ],
      "organization_group": "https://example.rossum.app/api/v1/organization_groups/17",
      "ui_settings": {},
      "metadata": {
        "some_key": "some_value"
      },
      "is_trial": true,
      "created_at": "2019-09-02T14:28:11.000000Z",
      "trial_expires_at": "2020-09-02T14:28:11.000000Z",
      "internal_info": {
        "cs_account_classification": null,
        "customer_type": null,
        "market_category": null,
        "overdue_payment_date": null,
        "sso_active": false
      },
      "creator": "https://example.rossum.app/api/v1/users/10775",
      "modified_by": "https://example.rossum.app/api/v1/users/10775",
      "modified_at": "2021-04-26T10:08:03.856648Z",
      "settings": {}
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.