Get a list of organizations

GET

/system/orgs

curl --request GET \
  --url 'https://example.com/api/v1/system/orgs?limit=50&offset=0' \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Query Parameters

level

integer

Set detail level of return value. Usually ranges from 0 to 2.

limit

integer

default: 50

Maximum number of results to return

offset

integer

0

Index of the first element to return

match

string

Match by substring

matchFields

string

Comma separated list of attributes to restrict matching to.

sort

string

/^(ID|name|description)(,(a|de)sc)?$/

Sort by attribute. Can be given multiple times.

name

string

Filter by name

description

string

Filter by description

Responses

200

List of organizations returned

Media typeapplication/json

object

data

Array<object>

object

ID

Unique ID of the object

integer

name

string

description

string

nullable

domainCount

Number of domains in this organization

integer

domains

List of domains belonging to the organization

Array<object>

object

ID

Unique ID of the object

integer

domainname

string

displayname

string

Example^generated

{
  "data": [
    {
      "name": "example",
      "description": "example",
      "domainCount": 1,
      "domains": [
        {
          "domainname": "example",
          "displayname": "example"
        }
      ]
    }
  ]
}

400

Validation of input parameters failed

Media typeapplication/json

object

message

string

errors

List of errors encountered during validation

Array<string>

Example^generated

{
  "message": "example",
  "errors": [
    "example"
  ]
}

500

An error occurred while processing the request

Media typeapplication/json

object

message

String representation of the exception

string

Example^generated

{
  "message": "example"
}

503

The database query failed

Media typeapplication/json

object

message

Description of the error

string

Example^generated

{
  "message": "example"
}