KAkantata
User Group Memberships

Fetching a list of User Group Memberships

This endpoint returns structured User Group Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the user_group_memberships top-level JSON key. Please see our Response Format section for more information.

get/user_group_memberships

Request

  • Base URL
    https://api.mavenlink.com/api/v1
  • Auth
    none declared

Query parameters

group_idsstring

Return only memberships associated with the specified Workspace Group IDs. Provide a comma-separated list of Workspace Group IDs or an array of IDs. For example, 10,20.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - Retrieves the associated user. The response will include user_id, which references the data in the users top-level key.
  • workspace_group (WorkspaceGroup) - Retrieves the associated Workspace Group. The response will include workspace_group_id, which references the data in the workspace_groups top-level key.
onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc and created_at:desc.

pageinteger
per_pageinteger
user_idsstring

Return only memberships associated with the specified user IDs. Provide a comma-separated list of user IDs or an array of IDs. For example, 10,20.

Response

A list of User Group Memberships have been retrieved.

countinteger
user_group_membershipsobject
usersobject
workspace_groupsobject

Changes

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