latestOpenAPI 3.0.02026-08-19219210532.7 KB

bd5a5f406bca

crm

List all users with optional filters

get/api/v1/users

Query parameters

idsstring[] nullable

Array of IDs to filter results. To skip this filter, omit the key entirely from your JSON. Never write the bare word undefined (that is invalid JSON). Empty arrays and null are also treated as omission.

pagenumber

Page number starting from 1.

limitnumber

Limit for the number of results per page.

teamIdstring

Optional. Restrict results to users in this team. Omit to include users from all teams.

teamIdsstring[]

Optional. Restrict results to users in any of these teams. Combined with ids/teamId as an intersection.

excludeTeamIdstring

Optional. Exclude users belonging to this team. Omit to apply no exclusion.

manageable'true'

Optional. Set to "true" to only return users the current user can manage. Omit for no manageability filter.

namestring

Optional. Filter by full name (case-insensitive substring match against "firstName lastName"). Omit to return users regardless of name.

searchStringstring

Optional. Search users by name or email (substring match). Omit to return users regardless of name/email.

searchstring

Optional. Fuzzy search across firstName, lastName, and email — tolerates typos and partial input (e.g. "jhon" finds "John", "jo" finds "John"), ranked by similarity. Composable with searchString.

role'Owner' | 'Manager' | 'Editor' | 'Member' | 'Assistant User'

Optional. Filter by user role. Omit to return users with any role.

createdAfterstring date-time

Optional. Inclusive lower bound (>=) on user creation date, as an ISO 8601 date-time string. Users created on/after this instant are included. Omit for no lower bound.

createdBeforestring date-time

Optional. Exclusive upper bound (<) on user creation date, as an ISO 8601 date-time string. Users created strictly before this instant are included. Omit for no upper bound.

createdAt'ASC' | 'DESC'
lastLoginDate'ASC' | 'DESC'
name'ASC' | 'DESC'
roles'ASC' | 'DESC'

Response