Authorizations

Authorization
string
headerrequired

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

status
enum<string>

Filter users by status. Users that are in_review are users that have been flagged for fraud risk and is pending review.

Available options:
verified,
unverified,
in_review,
disabled
starting_after
string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa, your subsequent call can include starting_after=aaa in order to fetch the next page of the list.

limit
integer

A limit on the number of objects to be returned, between 1 and 100.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa, your subsequent call can include ending_before=aaa in order to fetch the previous page of the list.

Response

200 - application/json
data
object[]

Array of user objects.

has_more
boolean

true if there are more objects.