Get Team Users

get

https://api.zylo.com/v2/users

Required Permissions

team:read

Rate Limit

basic

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

apps_owned

string

^^([0-9]{1,}([.][0-9]{0,})?,(gt|gte),([0-9]{1,}([.][0-9]{0,})?,(lt|lte)))$|^([0-9]{1,}([.][0-9]{0,})?,(lt|gt|gte|lte))$

Number of applications that the user has been set as one of the types of "owner" within Zylo: Application Owner, Business Owner, or IT Owner.

custom_fields

string

Values for custom fields associated with this User.
See custom field details here.

date_disabled

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

The date at which the user's status was marked as disabled.

string

^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,}$

A user's email via any direct, HR, or SSO integration.

email_domain

string

The email domain of the user's email.

external_status

string

User's external status as it comes in directly from your Employee Roster.

full_name

string

A user's full name via any direct, HR, SSO integration, or will be pulled from the Employee Roster if one is setup. Use the link below for setup steps.

string

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

A user's Zylo id.

in_employee_roster

boolean

Whether the user's email matches an active record in the Employee Roster. This is the best indicator for identifying departed or former employees — filter on in_employee_roster = false to find users who are no longer at the company or were never imported into the roster.

is_archived

boolean

Marked as archived if Zylo account has been deleted from the Team page.

notes

string

Any notes a Zylo account has associated with a user.

tags

zylo_created_at

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Date and time the user was first added to Zylo, either by an admin or from an integration.

zylo_modified_at

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Date and time the record was last modified in Zylo. Uses the created date by default.

zylo_status

string

Whether a user is considered active or disabled based on the External Status propagated from the Employee Roster. This field only reflects an explicitly set status and may remain empty when a user departs. To identify departed or former users, prefer in_employee_roster instead.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok