Organizations

List organizations

Changed on

Returns every organization the caller can view, with search, sort and cursor pagination. The caller must have organization view permission on the x-organization-id org.

get/api/v3/organizations

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/organizations
  • Auth: HTTP bearer and API key in header x-organization-id and API key in header x-api-key and API key in header x-gw-region

Query parameters

propertystring[] 
Property filters. Can be repeated and are AND-ed together.

Allowed fields:
- id
- name
- externalId

Supported operators:
- ==  (equals)
- !=  (not equals)
- >   (greater than)
- >=  (greater than or equal)
- <   (less than)
- <=  (less than or equal)
- ~   (case-insensitive regex match)

Special cases:
- field           → field exists
- !field          → field does not exist

[
  "teamId==3849"
]
startstring

Paging cursor. Must correspond to "orderby" field and used only when it is set.

limitinteger

Maximum number of items to return. Must be a positive integer. Range 1–200.

orderbystring
Example:+id

Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name.

Headers

x-organization-idstring required

Response

Cursor-paginated organizations

Example response

{
  "_page": {
    "orderby": "+id",
    "start": "123",
    "next": "124",
    "count": 100
  },
  "_links": {
    "next": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304",
    "page": "/v3/{{resource}}{?orderby,start,limit,property,type}"
  },
  "items": [
    {
      "id": 12989,
      "name": "Acme Inc.",
      "countryId": 1,
      "timezoneId": 113,
      "license": {
        "users": 10,
        "operations": 10000,
        "transfer": 1073741824,
        "interval": 1
      },
      "externalOrgId": "1234ABCD@AdobeOrg",
      "imsMigrated": true,
      "teams": [
        {
          "id": 777,
          "name": "Marketing"
        }
      ]
    }
  ]
}

Changes

  • 2dca0f26bbfdRevision changes
    • warning

      removed the optional property //// from the response with the status

  • 954cbf65a33dRevision changes
    • breaking

      added the new required header request parameter x-organization-id

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • breaking

      removed the required property // from the response with the status

    • info

      api tag Organizations added

    • info

      api tag Users removed