Skip to main content
GET
List users

Authorizations

Authorization
string
header
required

A Parley API key.

Query Parameters

Case-insensitive. Every word must appear in the user's first name, last name, or email.

Minimum string length: 1
role
enum<string>

Only users with this role.

Available options:
owner,
admin,
member,
parley
sort
enum<string>
default:-createdAt

Sort order: a field name, prefixed with - for descending. Defaults to -createdAt.

Available options:
email,
-email,
createdAt,
-createdAt
cursor
string

Opaque cursor from nextCursor. Pass the same filters and sort. Omit for the first page.

Minimum string length: 1
limit
integer
default:50

Maximum number of items to return.

Required range: 1 <= x <= 250

Response

OK

data
object[]
required
nextCursor
string | null
required

Cursor for the next page, or null on the last page.