List the caller's Organizations

List a page of Organizations the credential's user belongs to, oldest first. Follow nextPageToken to read subsequent pages.

GET

/organizations

Authorization

headerx-api-key<token>

A Dashform API key, sent in the x-api-key header. Keys are created in the dashboard and act as the user who owns them.

Query Parameters

filter?string

AIP-160 filter over createTime, name, and slug. The caller's own membership always scopes the collection, so an expression here can only narrow it further.

Default""

orderBy?string

AIP-132 ordering over createTime, name, and slug. Defaults to oldest first, with the slug breaking ties.

Default""

pageSize?integer

Maximum number of resources to return in one page. Omit or set to 0 to return up to 10 resources. Values above 1000 are capped at 1000. A page may contain fewer resources than requested; use nextPageToken to continue.

Range0 <= value <= 9007199254740991

Default10

pageToken?string

Opaque continuation token from the previous list response.

Default""

skip?integer

Number of resources to skip before returning a page, starting from the page token's position if supplied. Omit or set to 0 to skip none. Skipping past the end returns an empty page and no continuation token.

Range0 <= value <= 2147483647

Default0

Response Body

application/json

response

nextPageToken*string

Continuation token for the next page. Empty on the final page.

totalSize*integer

Number of resources matching the filter before pagination. Estimates must be documented.

Range0 <= value <= 9007199254740991

organizations*array<>

Example Request

curl -X GET 'https://getaiform.com/api/v1/organizations'

Example ResponseSchema

{  "nextPageToken": "string",  "totalSize": 0,  "organizations": [    {      "createTime": "2019-08-24T14:15:22Z",      "logo": "string",      "metadata": "string",      "name": "string",      "path": "string",      "slug": "string"    }  ]}