List users

get https://app.modzy.com/api/accounting/users

This endpoint returns a list of all the users. It can be sorted by identifier, externalIdentifier, firstName, lastName, email, and lastActiveDatetime. When no values are provided, it orders by identifier.

🚧
Roles
Projects cannot access this route.

📘
This collection route supports filters and pagination.

Query Params

firstName

string

Filters by the user’s first name.

lastName

string

Filters by the user’s last name.

string

Filters by the user’s email.

string

Filters by the firstName, lastName, or email and returns similar matches.

status

string

Filters by the user’s status and returns exact matches. Values can be Active, Inactive, Invited, Rejected, or Deleted.

accessKey

string

Filters by the user’s key prefix and returns exact matches.

startDate

date-time

Filters based on a window starting on this date. Format should be ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.

endDate

date

Filters based on a window ending on this date. Format should be ISO8601 (YYYY-MM-DDThh:mm:ss.sTZD) format.

searchDate

string

Indicates whether date window filters are based on createdAt or updatedAt fields. Defaults to updatedAt.

Responses

Language

Credentials

Header

Request


xxxxxxxxxx
1
curl --request GET \
2
     --url https://app.modzy.com/api/accounting/users \
3
     --header 'Authorization: ApiKey <YOUR API KEY HERE>' \
4
     --header 'accept: application/json'

Choose an example:

application/json

🚧Roles

📘

200200

400400

🚧
Roles