Organization Group

Retrieve user

Get user for an organization group object. Returned object contains subset of user attributes.

<Callout type="info"> The endpoint provides read-only view for users with the `organization_group_admin` role for managing memberships. </Callout>
get/api/v1/organization_groups/{organizationGroupID}/users/{userID}

Path parameters

organizationGroupIDinteger required

A unique integer value identifying organization group.

userIDinteger required

User ID

Response

OK

idinteger

ID of the user.

urlstring uri

Membership URL of the user.

emailstring email

Email of the user.

usernamestring

Username of a user.

organizationstring uri

Related organization.

Example response

{
  "id": 123456,
  "url": "https://example.rossum.app/api/v1/organization_groups/42/users/123456",
  "email": "john-doe@east-west-trading.com",
  "username": "JohnDoe",
  "organization": "https://example.rossum.app/api/v1/organization_groups/42/organizations/321"
}

Changes

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