Qodex.ai

List all users.

GET {{baseUrl}}/v4/users?search=nisi dolor sed ullamco&createdAt[gt]=2015-01-23T23:50:07Z&createdAt[gte]=2015-01-23T23:50:07Z&createdAt[lt]=2015-01-23T23:50:07Z&createdAt[lte]=2015-01-23T23:50:07Z&searchFields=fullName&limit=10&cursor=MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw

List of all the users that belong to any of the locations that the caller has access to.

If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned.

Request Params

KeyDatatypeRequiredDescription
searchstringString you would like to search for in the searchFields parameter.
createdAt[gt]stringFilter on the createdAt date.
createdAt[gte]stringFilter on the createdAt date.
createdAt[lt]stringFilter on the createdAt date.
createdAt[lte]stringFilter on the createdAt date.
searchFieldsstringA list of the fields where you want to search for the search parameters. e.g. ?searchFields[]=name&searchFields[]=displayname
limitnumberMax number of items to return per request. Defaults to 10.
cursorstringRetrieves the page of items that comes after the cursor.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"data":[{"archived":false,"createdAt":"2015-01-23T23:50:07Z","email":"bob.ross@gmail.com","firstName":"Bob","lastName":"Ross","locations":[{"uid":"00000000-0000-0000-0000-000000000000"},{"uid":"00000000-0000-0000-0000-000000000000"}],"phone":"+18013586533","role":"Account Owner","uid":"00000000-0000-0000-0000-000000000000"},{"archived":false,"createdAt":"2015-01-23T23:50:07Z","email":"bob.ross@gmail.com","firstName":"Bob","lastName":"Ross","locations":[{"uid":"00000000-0000-0000-0000-000000000000"},{"uid":"00000000-0000-0000-0000-000000000000"}],"phone":"+18013586533","role":"Account Owner","uid":"00000000-0000-0000-0000-000000000000"}],"metadata":{"nextCursor":"MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw","previousCursor":"MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw","totalItems":3023745,"url":"https://www.podium.com/"}}