Get Zylo Users

get

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

Required Permissions

admin

Rate Limit

basic

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

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

The email of the Zylo user.

first_name

string

The first name of the Zylo user.

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}

Unique identifier for a Zylo user.

in_view

boolean

Whether the Zylo user is in a view.

last_login

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 and time of the last login for the Zylo user.

last_name

string

The last name of the Zylo user.

permissions

array of strings

Roles assigned to this Zylo user. Updating permissions replaces the entire set — any role omitted from the request is removed, not merged. See the permissions reference for the full list of available roles.

permissions

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 record was created in Zylo.

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.

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