ListOrganizations

List Organizations

Search for Organizations. By default, we will return all organization of the instance that you have permission to read. Make sure to include a limit and sorting for pagination.

Required permission:

org.read

Request Body

application/json

query?

list limitations and ordering

sortingColumn?string

the field the result is sorted

Value in"ORGANIZATION_FIELD_NAME_UNSPECIFIED" | "ORGANIZATION_FIELD_NAME_NAME" | "ORGANIZATION_FIELD_NAME_CREATION_DATE"

queries?

criteria the client is looking for

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/v2/organizations/_search" \
  -H "Content-Type: application/json" \
  -d '{}'

curl -X POST "https://loading/v2/organizations/_search" \  -H "Content-Type: application/json" \  -d '{}'

{
  "details": {
    "totalResult": 0,
    "processedSequence": 0,
    "timestamp": "1s"
  },
  "sortingColumn": "ORGANIZATION_FIELD_NAME_UNSPECIFIED",
  "result": [
    {
      "id": "string",
      "details": {
        "sequence": 0,
        "changeDate": "1s",
        "resourceOwner": "string",
        "creationDate": "1s"
      },
      "state": "ORGANIZATION_STATE_UNSPECIFIED",
      "name": "string",
      "primaryDomain": "string"
    }
  ]
}

{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

ListOrganizations

Request Body

Response Body

200application/json

defaultapplication/json

`application/json`

`application/json`