Users
API endpoints for users
View users.
Users all have a single base role, and can be assigned multiple custom roles. They can be managed via your Slack workspace or SAML provider.
The user object
Show child attributes
Show child attributes
Example:
{
"description": "Elevated permissions for the customer success team.",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "Customer Success",
"slug": "customer-success"
}
Show child attributes
Show child attributes
Example:
[
{
"description": "Elevated permissions for the customer success team.",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "Customer Success",
"slug": "customer-success"
}
]
Unique identifier of the user
Example:
"01FCNDV6P870EA6S7TK1DSYDG0"
Whether the user is active. False if the user has been deactivated (e.g. offboarded) or is not yet active.
Example:
true
Name of the user
Example:
"Lisa Karlin Curtis"
DEPRECATED: Role of the user as of March 9th 2023, this value is no longer updated.
Available options:
viewer, responder, administrator, owner, unset Example:
"owner"
Show child attributes
Show child attributes
Example:
{
"on_call": "full_access",
"response": "viewer_only"
}
Email address of the user.
Example:
"lisa@incident.io"
Slack ID of the user
Example:
"U02AYNF2XJM"
Was this page helpful?
{
"base_role": {
"description": "Elevated permissions for the customer success team.",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "Customer Success",
"slug": "customer-success"
},
"custom_roles": [
{
"description": "Elevated permissions for the customer success team.",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"name": "Customer Success",
"slug": "customer-success"
}
],
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"is_active": true,
"name": "Lisa Karlin Curtis",
"role": "owner",
"seats": {
"on_call": "full_access",
"response": "viewer_only"
},
"email": "lisa@incident.io",
"slack_user_id": "U02AYNF2XJM"
}