Sign in

v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB
Group memberships

Get group membership

Retrieves a specific group membership. Only admins of this group or users with admin-level permissions will be able to use this API.

get/group_memberships/{group_membership_id}

Path parameters

group_membership_idstring required

The ID of the group membership.

Query parameters

fieldsstring[]

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Response

Returns the group membership object.

idstring

The unique identifier for this group membership.

type'group_membership'

The value will always be group_membership.

role'member' | 'admin'

The role of the user in the group.

created_atstring date-time

The time this membership was created.

modified_atstring date-time

The time this membership was last modified.

Example response

{
  "id": "11446498",
  "type": "group_membership",
  "user": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "group": {
    "id": "11446498",
    "type": "group",
    "name": "Support",
    "group_type": "managed_group"
  },
  "role": "member",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00"
}