List User Segments
GET {{baseUrl}}/api/v2/help_center/user_segments?built_in=<boolean>
Some user segments can only be applied to sections and topics on certain Guide plans. For instance, user segments with a user_type of "staff" cannot be applied to sections and topics on accounts on the Guide Lite plan or the Suite Team plan. To request only user segments applicable on the account's current Suite plan, use the /api/v2/help_center/user_segments/applicable.json endpoint.
The /api/v2/help_center/users/{user_id}/user_segments.json endpoint returns the list of user segments that a particular user belongs to. This is the only list endpoint that agents have access to. When an agent makes a request to this endpoint with another user's id, the response only includes user segments that the requesting agent also belongs to.
These endpoints support pagination, as described in the pagination documentation.
Allowed for
- Help Center managers
- Agents
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
built_in | string | Only built_in user segments if true, only custom user segments if false |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"user_segments":[{"user_type":"\u003cstring\u003e","built_in":"\u003cboolean\u003e","created_at":"\u003cstring\u003e","group_ids":["\u003cinteger\u003e","\u003cinteger\u003e"],"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","or_tags":["\u003cstring\u003e","\u003cstring\u003e"],"organization_ids":["\u003cinteger\u003e","\u003cinteger\u003e"],"tags":["\u003cstring\u003e","\u003cstring\u003e"],"updated_at":"\u003cstring\u003e"},{"user_type":"\u003cstring\u003e","built_in":"\u003cboolean\u003e","created_at":"\u003cstring\u003e","group_ids":["\u003cinteger\u003e","\u003cinteger\u003e"],"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","or_tags":["\u003cstring\u003e","\u003cstring\u003e"],"organization_ids":["\u003cinteger\u003e","\u003cinteger\u003e"],"tags":["\u003cstring\u003e","\u003cstring\u003e"],"updated_at":"\u003cstring\u003e"}]}