Organization Group

Retrieve organization group

Get an organization group object.

get/api/v1/organization_groups/{organizationGroupID}

Path parameters

organizationGroupIDinteger required

A unique integer value identifying organization group.

Response

OK

idinteger

ID of the organization group.

namestring

Name of the organization group.

is_trialboolean

Property indicates whether this license is a trial license.

is_productionboolean

Property indicates whether this licence is a production licence.

deployment_locationstring

Deployment location identifier.

featuresobject nullable

Use the /features endpoint instead. Enabled features (for internal use only).

usageobject

Enabled priced features (for internal use only).

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

Example response

{
  "id": 42,
  "name": "Rossum group",
  "is_production": true,
  "deployment_location": "prod-eu",
  "usage": {},
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.