GET/api/v1/users

Get Users

Retrieves a paginated list of users for the tenant with optional filters. Use metadata=[campo=valor] format for metadata filtering.

Authentication

Send your API key in the x-api-key header.

x-api-keybearer

Parameters

page

query · number

Page number for pagination (default: 1)

limit

query · number

Number of items per page (default: 10)

email

query · string

Filter by email (partial match)

phone

query · string

Filter by phone (partial match)

metadata

query · array

Filter by metadata fields (format: [campo=valor]&[campo2=valor2])

Responses

200

PublicApiGetUsersResponseDto

statusCoderequired

number

countrequired

number

errorrequired

string

datarequired

array<PublicApiUserDto>

Array of users

Example response

json

{
  "statusCode": 200,
  "count": 0,
  "error": null,
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+1234567890",
      "position": "sales_manager",
      "metadata": {
        "salesRegion": "North",
        "customerId": "12345"
      },
      "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
    }
  ]
}

401Unauthorized - missing or invalid API key or Bearer token