TAtalkdesk
Attributes API

Attribute Users List

Returns a paginated list of users to whom a specific attribute has been assigned. Use this endpoint to inspect attribute membership, for example when auditing agent skill assignments or building an attribute-users management view. For team-scoped users, the attribute must be within their team scope and only users within their teams are returned. Results can be filtered by attribute name.

get/attributes/{attribute_id}/users

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/attributes/{attribute_id}/users
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: attributes:read

Path parameters

attribute_idstring required

The identifier of the attribute.

Query parameters

pageinteger

Desired page. Defaults to 1.

per_pageinteger

Limit the number of attributes per page. Defaults to 50.

namestring

Filter by attribute 'name'.

Response

Attribute users list

totalinteger
countinteger
pageinteger
per_pageinteger

Example response

{
  "total": 2,
  "count": 1,
  "page": 1,
  "per_page": 1,
  "_embedded": {
    "attribute_users": [
      {
        "id": "eba9a399-4960-4499-952f-5867275b597a",
        "name": "User 1",
        "team": "Team",
        "proficiency": 60,
        "_links": {
          "attribute": {
            "href": "http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000/users"
    },
    "page": {
      "href": "http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000/users?page=1"
    },
    "next": {
      "href": "http://api-docs.talkdesk.org/attributes/123e4567-e89b-12d3-a456-426655440000/users?page=2"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.