Get detailed information about an organization

GET

/system/orgs/{ID}

curl --request GET \
  --url https://example.com/api/v1/system/orgs/1 \
  --cookie grommunioAuthJwt=<grommunioAuthJwt>

• Default deployment path

Authorizations

• JWTCookie

Parameters

Path Parameters

ID

required

integer

ID of the object

Query Parameters

level

integer

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

Responses

200

Organization returned

Media typeapplication/json

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

{
  "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"
  ]
}

404

The requested resource could not be found

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "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"
}