Bevatel

List Users

GET/v1/users

Returns users belonging to the workspace identified by x-workspace-id, ordered by created_at descending. Optional service_id (query) or x-service-id (header) filters users that have a role for that service and includes a role field on each item. When omitted, all workspace users are returned without a role field. Empty results return 200 with data: [] and meta.total: 0.

Query Parameters

pageinteger
Example:1
per_pageinteger
Example:25
service_idstring

Optional service UUID. When set, only users with a role for this service are returned and each item includes role. Alternatively send x-service-id header.

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6
searchstring

Optional case-insensitive match against username or email.

Example:text
rolestring

Optional role name filter. Only applied when service_id / x-service-id is also provided.

Example:text

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required
Example:200
messagestring required
Example:OK
detailsobject required
dataarray[object] required
idstring (uuid)•Identity user UUID required
usernamestring required
emailstring (email) required
imgstring or null•Public URL to profile image
extensionstring or null•Call center extension number when available
is_ownerboolean required
is_activeboolean required
rolestring•Role code name for the requested service
Example:agent
metaobject (GeneralPaginationMeta) required
current_pageinteger required
per_pageinteger required
totalinteger required
last_pageinteger required
linksobject required
firststring required
laststring required
prevstring or null required
nextstring or null required
error_codeinteger•Numeric error code matching the HTTP response status. required
Example:400
messagestring required
detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required
error_codeinteger•Numeric error code matching the HTTP response status. required
Example:400
messagestring required
detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required
error_codeinteger•Numeric error code matching the HTTP response status. required
Example:400
messagestring required
detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required
error_codeinteger•Numeric error code matching the HTTP response status. required
Example:400
messagestring required
detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required