Skip to content

Insights Access Group Memberships

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

Note: To manage access to dynamic Insights, use Access Group Memberships instead.

Operations

Fetching a list of Insights Access Group Memberships

Request

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

Query
by_access_group_idinteger, (int32)

Return only memberships associated with a specified Insights Access Group ID.

by_user_namestring

Return only memberships associated with a specified user name.

includestring

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

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

optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Enum:"user_name""account_permission"
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_idsArray of integers, (int32)

Return only memberships associated with the specified user IDs.

GET
/insights_access_group_memberships
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/insights_access_group_memberships?by_access_group_id=0&by_user_name=string&include=string&only=string&optional_fields=user_name&order=created_at%3Adesc&page=1&per_page=20&user_ids=0'

Responses

A list of Insights Access Group Memberships have been retrieved.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
insights_access_group_membershipsobject
usersobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "insights_access_group_memberships": {
    "property1": {
      "account_permission": "string",
      "can_edit": true,
      "created_at": "2019-08-24T14:15:22Z",
      "insights_access_group_id": 0,
      "insights_access_group_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": 0,
      "user_name": "string"
    },
    "property2": {
      "account_permission": "string",
      "can_edit": true,
      "created_at": "2019-08-24T14:15:22Z",
      "insights_access_group_id": 0,
      "insights_access_group_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "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"
      ]
    }
  }
}