Identra Docs
Reference / Users

browse the application's end-users (search + status filter, paginated).

GET /v1/users
Secret API key operationId: list

Authorization

Server-to-server. Send a secret key as a Bearer token plus the x-application-id header.

Query parameters

  • search string optional

    Email substring

  • status string optional

    active | banned | locked

  • limit integer<int64> optional

    Page size (1..=100)

  • offset integer<int64> optional

    Page offset

Responses

200 Users
{
  "data": {
    "items": [
      {
        "created_at": null,
        "email_verified": null,
        "id": null,
        "primary_email": null,
        "profile": null,
        "status": null
      }
    ],
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "meta": {
    "timestamp": "string"
  },
  "success": false
}

Request

curl -X GET "http://localhost:8080/v1/users" \

Try it

live request
GET http://localhost:8080/v1/users

Query parameters