Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
users

Get Users

Use this endpoint to get the list of users for a company. The status filter can be used to filter users based on status - active, inactive, archived, or deleted. By default, only active users will be returned. This endpoint will return a paginated response starting from the given record index.

get/users

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
recordStartIndexinteger

The index of the first element to return

statusstring

Return users of the listed status. Possible values are Active, Inactive, Archived, and Deleted. Multiple values are given comma seperated. To return all users - Active,Inactive,Archive,Deleted. When no status parameter is given, the Active users are returned.

Response

OK

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

Example response

{
  "items": [
    {
      "id": "228db892-3b49-4455-b839-ffd8576d8731",
      "role": {
        "id": 3,
        "name": "Manager"
      },
      "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
    }
  ]
}