ACacculynx
users

Get Users

Changed on

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

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/users
  • Auth
    HTTP bearer

Query parameters

pageSizeinteger

How many items to be returned at a time.

pageStartIndexinteger

The value of pageStartIndex will specify the index of the record that the list begins with.

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 matching the current query.

pageSizeinteger

The requested or default page size.

pageStartIndexinteger

The requested or default index of the first element to return.

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"
    }
  ]
}

Changes

  • 443924b00f43Revision changes
    • breaking

      for the query request parameter pageSize, default value 25 was removed

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      deleted the query request parameter recordStartIndex

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional query request parameter pageStartIndex

    • info

      added the optional property to the response with the status