Skip to content

User Group Memberships

A User Group Membership represents the connection of a user to a Workspace Group. You must be an Account Administrator to use these endpoints.

Operations

Fetching a list of User Group Memberships

Request

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.

Query
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.

Default:"created_at:desc"
pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
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.

GET
/user_group_memberships
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/user_group_memberships?group_ids=string&include=string&only=string&order=created_at%3Adesc&page=1&per_page=20&user_ids=string'

Responses

A list of User Group Memberships have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
user_group_membershipsobject
usersobject
workspace_groupsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "user_group_memberships": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": 0,
      "user_id": 0,
      "workspace_group_id": 0
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": 0,
      "user_id": 0,
      "workspace_group_id": 0
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "workspace_groups": {
    "property1": {
      "address": "string",
      "company": true,
      "contact_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "notes": "string",
      "phone_number": "string",
      "rate_card_set_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "website": "string",
      "workspace_ids": [
        "string"
      ]
    },
    "property2": {
      "address": "string",
      "company": true,
      "contact_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "email": "string",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "notes": "string",
      "phone_number": "string",
      "rate_card_set_ids": [
        "string"
      ],
      "updated_at": "2019-08-24T14:15:22Z",
      "website": "string",
      "workspace_ids": [
        "string"
      ]
    }
  }
}