Skip to main content
User List API
curl --request GET \
  --url https://api.pazy.io/v1.0/users

Documentation Index

Fetch the complete documentation index at: https://docs.pazy.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

All requests require an API key in the request headers. Headers: 
Authorization: Api-Key YOUR_API_KEY

​
Request

Content-Type: application/json

​
Query Parameters

ParameterTypeRequiredDescription
namestringNoFilter users by name (partial match). Min 1, Max 100 characters.
limitintegerNoNumber of records to return. Min 1, Max 100.
cursorstringNoCursor for pagination. Default 0.

​
Code Examples

curl -X GET "https://api.pazy.io/v1.0/users?limit=30" \
  -H "Authorization: Api-Key YOUR_API_KEY"

​
Success Response

HTTP Status: 200 OK Response Fields:
FieldTypeDescription
okbooleanIndicates whether the request was successful
dataobjectContains the user list response data
data.usersarrayList of users
data.users[].idstringUnique identifier for the user
data.users[].namestringFull name of the user
data.contextobjectPagination metadata
data.context.hasMorebooleanIndicates whether there are more users to fetch
data.context.nextCursornumberCursor to fetch the next page

​
Response Example

{
  "ok": true,
  "data": {
    "users": [
      {
        "id": "<userId>",
        "name": "John Doe"
      },
      {
        "id": "<userId>",
        "name": "Jane Smith"
      }
    ],
    "context": {
      "hasMore": true,
      "nextCursor": 30
    }
  }
}

​
Error Responses

​
Validation Error

HTTP Status: 400 Bad Request 
{
  "ok": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed: /query/limit: must be <= 100"
  }
}

​
Authentication Errors

HTTP Status: 401 Unauthorized 
{
  "ok": false,
  "error": {
    "code": "MISSING_CREDENTIALS",
    "message": "Missing Credentials"
  }
}

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API Key"
  }
}

​
Permission Errors

HTTP Status: 403 Forbidden 
{
  "ok": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Permission check failed - PERMISSION_CHECK_FAILED"
  }
}

​
Internal Error

HTTP Status: 500 Internal Server Error 
{
  "ok": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}

​
Best Practices

  • Use the id returned for a user as the input to the User Details API for full user information
  • Use name to narrow down results — partial matching is supported (e.g., John matches John Doe, Johnny)
  • Use cursor and limit together to paginate; nextCursor from the response can be used as the cursor value for the next call