Skip to main content
GET
/
api
/
organizations
/
v1
/
organizations
Get the Organizations for a user
curl --request GET \
  --url https://api.example.com/api/organizations/v1/organizations \
  --header 'X-Domino-Api-Key: <api-key>'
{
  "metadata": {
    "notices": [
      "<string>"
    ],
    "requestId": "<string>",
    "limit": 123,
    "offset": 123,
    "totalCount": 123
  },
  "orgs": [
    {
      "id": "623132867a0af0281c01a69c",
      "members": [
        {
          "userId": "6234c9542bc6731e3471ade8"
        }
      ],
      "name": "MyOrg",
      "defaultEnvironmentId": "6231327c7a0af0281c01a65f"
    }
  ]
}

Authorizations

X-Domino-Api-Key
string
header
required

Query Parameters

nameFilter
string

Optional value to filter organization names with. Must exactly match organization name.

offset
integer

How many orgs from the start to skip. Defaults to 0.

limit
integer

Max number of orgs to fetch. Defaults to 10.

Response

Success

metadata
object
required
orgs
object[]
required