API ReferenceReferenceUser groups
Get a user group
The group plus its member roster (oldest first) and its access grants.
Requires the end_users:read scope.
Authorization
apiKey AuthorizationBearer <token>
An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
groupId*string
Format
uuidResponse Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/user-groups/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "userGroup": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "description": "string", "createdAt": "2019-08-24T14:15:22Z", "members": [ { "endUserId": "120e9d1f-8444-4b91-85e8-5b208615a3e5", "email": "user@example.com", "fullName": "string", "addedAt": "2019-08-24T14:15:22Z" } ], "grants": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "targetKind": "app", "targetId": "cbca1126-180e-4334-9df8-cf82289d378b", "effect": "allow", "deploymentId": "a73c85a1-d857-491e-a6b2-51dce05de7a2", "source": "string", "expiresAt": "2019-08-24T14:15:22Z" } ] }}