User resource

Get user list - Get all users v1

OVERVIEW

Use this method to obtain a list of system level users

(Only available in Collaborate 4.3 and above)

Request URI

GET   /api/3/users?status={status}&offset={offset}&limit={limit}


Request Parameters

Parameter name Type Description
status
(Optional)		 String

Possible values for the status are Active, Archived and Inactive.

If a value is not provided, the API endpoint will return a list of all users with any status in the system. i.e if the user is active, archived or inactive.

offset

(Optional)

 Integer The starting position of the user list from when the user list  should be returned. This is to allow pagination

limit

(Optional)

 Integer The no of items to return in an individual get call

 

Response

The response contains a list of system level users.


System user list

 

Notes

  • The value of limit parameter behaves as following:
    • If no value is provided in limit, it takes 100 as a default value.
    • If limit is higher than 0 then it uses that value as limit.
    • To return all the records use -1 for limit.
    • If limit is  lower than -1 then limit value is set to default value 100.
  • The value of offset parameter behaves as following:
    • If no value is provided in offset , it takes 0 as a default value.
    • If offset is lower than 0 then an offset value is set to default value 0.
    • If the offset is higher than 0 and less than number records of user list then the records starting from the offset value returned.
    • If the offset is higher than total number records of user list then the offset is set to default value 0.

 

Comments


0 Comments

Last Updated: Nov 08,2024