Skip to content

Access Group Memberships

Access Groups allow you to manage product access for users. An Access Group Membership represents the connection of a user to an Access Group.

Operations

Fetching a list of Access Group Memberships

Request

Returns all access group memberships. The non-editable "Account Administrators" group is excluded from the response.

This endpoint returns structured Access 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 access_group_memberships top-level JSON key. Please see our Response Format section for more information.

Query
access_group_idinteger, (int32)

Returns only access group memberships for a specified access group.

includestring

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

  • access_group (AccessGroup) - References the associated access group.
  • user (User) - References the associated user.
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.

pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
user_idinteger, (int32)

Returns only access group memberships for a specified user.

GET
/access_group_memberships
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/access_group_memberships?access_group_id=0&include=string&only=string&page=1&per_page=20&user_id=0'

Responses

A list of Access Group Memberships have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
access_group_membershipsobject
usersobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "access_group_memberships": {
    "property1": {
      "access_group_id": 0,
      "access_group_name": "string",
      "created_at": "2019-08-24",
      "creator_id": 0,
      "user_id": 0,
      "user_name": "string"
    },
    "property2": {
      "access_group_id": 0,
      "access_group_name": "string",
      "created_at": "2019-08-24",
      "creator_id": 0,
      "user_id": 0,
      "user_name": "string"
    }
  },
  "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"
      ]
    }
  }
}