API Reference

Get users

get
https://api.connecteam.com/users/v1/users

Retrieves a list of all users associated with the account. Optionally, filter by user ID to receive specific user information

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 500
Defaults to 10

The maximum number of results to display per page

integer
≥ 0
Defaults to 0

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

enum

Sort key

Allowed:
string
enum
Defaults to asc

Sort order, set only if sort key is set

Allowed:
userIds
array of integers

List of user IDs for filtering.

Userids
string
enum
Defaults to active

Filter users by status. Default is active.

Allowed:
fullNames
array of strings

List of full names to filter by. Specify the exact first and last name with a space between them as shown in the platform (ignore capitalization).

Fullnames
phoneNumbers
array of strings

List of phone numbers to filter by (in format +

Phonenumbers
emailAddresses
array of strings

List of email addresses to filter by (in format [email protected]).

Emailaddresses
integer
≥ 1

Parameter specifying the date in Unix format (in seconds). Only users created after this date will be included in the results.

integer
≥ 1

Parameter specifying the date in in Unix format (in seconds). Only users with fields updated after this date will be included in the results.

integer
≥ 1

Parameter specifying the date in in Unix format (in seconds). Only users who's logged in after this date will be included in the results.

integer
≥ 1

Parameter specifying the date in Unix format (in seconds). Only users archived after this date will be included in the results.

Responses

Updated 27 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 27 days ago