Users

Operations related to users

Get Users

get

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

Autorizaciones

x-api-key

x-api-keystringRequerido

Parámetros de consulta

pagenumberOpcional

Page number for pagination (default: 1)

Example: 1

limitnumberOpcional

Number of items per page (default: 10)

Example: 10

emailstringOpcional

Filter by email (partial match)

Example: [email protected]

phonestringOpcional

Filter by phone (partial match)

Example: [phone]

Respuestas

200Éxito

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/users

HTTPcURLJavaScriptPython

GET /api/v1/users HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "[phone]",
      "position": "Sales Manager",
      "metadata": {
        "salesRegion": "North",
        "customerId": "12345"
      },
      "personId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
    }
  ]
}

Update User Metadata

put

Updates the metadata for a specific user

Autorizaciones

x-api-key

x-api-keystringRequerido

Parámetros de ruta

idstringRequerido

Cuerpo

application/json

metadataobjectRequerido

Metadata fields to update for the user

Example: {"salesRegion":"South","customerId":"67890"}

Respuestas

200Éxito

application/json

401

Unauthorized - missing or invalid API key

put

/api/v1/users/{id}/metadata

HTTPcURLJavaScriptPython

PUT /api/v1/users/{id}/metadata HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 57

{
  "metadata": {
    "salesRegion": "South",
    "customerId": "67890"
  }
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "salesRegion": "South",
    "customerId": "67890"
  }
}