List all organizations

Returns a list of organizations. The organizations are returned sorted by creation date in ascending order.

GET/v3/organizations
JWTorganization:read

Query parameters

pageinteger

The page number.

Range: [1, 2147483647]Format: int32

limitinteger

The number of records per page. Must be a number between 1 and 100.

Range: [1, 100]Format: int32

sortstring

The sort string to sort the returned records e.g. "-createdAt"

Pattern: ([+-]\w*\.*\w*){1}(\|[+-]\w*){0,5}

nameobject

Name of the organization

emailobject

Notification email address of the organization.

resellerIdobject

Unique identifier for the reseller.

customAttributeobject

Custom attribute values associated with the organization, filtered as customAttribute.<name>[<op>]=value, e.g. customAttribute.region[eq]=EU.

includearray of string

Whether to include related entities in the response.

searchstring

Search string.

Length: [0,256]

idobject

ID of the resource.

createdAtobject

Date of creation

updatedAtobject

Date of last update

Response

200 OK

idstringrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time

namestringrequired
emailstringrequired
descriptionstringrequired
allowedUsersintegerrequired

Format: int32

addressobjectrequired
customAttributesarray of objectrequired
organizationAliasstring
resellerIdstring
resellerobject