GET /api/v2/users/{user_id}/groups
Returns a list of groups for the specified user.
Pagination
- Cursor pagination (recommended)
- Offset pagination
See Pagination.
Returns a maximum of 100 records per page.
Allowed For
- Admins
- Agents
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id |
Integer | Yes |
The id of the user |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
page |
No |
Pagination parameter. Supports both traditional offset and cursor-based pagination:
These are mutually exclusive - use one format or the other, not both. |
|
include_boundary_indicators |
Boolean | No |
When true, includes Only valid with cursor pagination (page[size], page[after], page[before]). |
per_page |
Integer | No |
Number of records to return per page. Note: Default and maximum values vary by endpoint. Check endpoint-specific documentation for limits. |
sort |
String | No |
Field to sort results by. Prefix with When used with cursor pagination, this determines the cursor ordering. Example: |
include_item_cursors |
Boolean | No |
When true, includes cursor values for each item in the cursor pagination response. Only valid with cursor pagination (page[size], page[after], page[before]). |
exclude_deleted |
Boolean | No |
Whether to exclude deleted entities |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.