Get a user attribute

GET

/v2/user-attributes/:userAttributeId

Get details for a specific user attribute.

Usage notes

Retrieve the userAttributeId by calling the /v2/user-attributes endpoint.

Get details for a specific user attribute. ### Usage notes - Retrieve the **userAttributeId** by calling the [/v2/user-attributes](https://help.sigmacomputing.com/reference/list-user-attributes) endpoint.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

userAttributeIdstringRequired

Response

The response body.

userAttributeIdstring

Unique identifier of the user attribute.

namestring

Name of the user attribute.

createdBystring

The identifier of the user who created this object.

updatedBystring

The identifier of the user or process that last updated this object.

createdAtdatetime

When the object was created.

updatedAtdatetime

When the object was last updated.

descriptionstring or null

Description of the user attribute.

defaultValueobject or null

Default value of the user attribute.

1	{
2	"userAttributeId": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"name": "Region",
4	"createdBy": "user_12345",
5	"updatedBy": "user_67890",
6	"createdAt": "2024-01-15T09:30:00Z",
7	"updatedAt": "2024-04-10T14:45:00Z",
8	"description": "Specifies the geographic region of the user.",
9	"defaultValue": {
10	"val": "North America",
11	"type": "string"
12	}
13	}

$	curl https://api.sigmacomputing.com/v2/user-attributes/userAttributeId \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"