Skip to navigation
Sigma REST APIUser attributesusers

Get users for a user attribute

View as Markdown

Get a list of users that have a specific user attribute defined, and the assigned value for the user attribute.

Usage notes

  • Retrieve the userAttributeId by calling the /v2/user-attributes endpoint.
  • Retrieve the userId by calling the /v2/members endpoint and using the memberId included in the response.
  • Use userId to return a single user’s assignment. The response is empty if the attribute is not assigned to that user.
  • Only values assigned directly to a user are returned. Default values and values a user inherits from a team are not included.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

userAttributeIdstringRequired
Unique identifier of the user attribute.

Query parameters

pagestringOptional
Use to specify further pages using the string returned in the nextPage portion of the response.
limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

userIdstringOptional
Unique identifier of the user.

Response

The response body.
entrieslist of objects
nextPagestring or null
totaldoubleOptional