API ReferenceapiidentityGET /v1/admin/users

GET /v1/admin/users

Service: identity · operationId: (none)

List platform members for staff support lookup

Required scopes

(no scope declared — review service config)

Query parameters

  • email (string) —
  • q (string) —
  • brand_id (string) —
  • page (integer) —
  • page_size (integer) —

Responses

200 Paginated user list

{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "user_id": {
            "type": "string"
          },
          "email": {
            "type": "string",
            "format": "email"
          },
          "name": {
            "type": [
              "string",
              "null"
            ]
          },
          "brand_id": {
            "type": [
              "string",
              "null"
            ]
          },
          "created_at": {
            "type": "string"
          }
        },
        "required": [
          "user_id",
          "email",
          "name",
          "brand_id",
          "created_at"
        ]
      }
    },
    "total": {
      "type": "integer"
    },
    "page": {
      "type": "integer"
    },
    "page_size": {
      "type": "integer"
    },
    "has_more": {
      "type": "boolean"
    }
  },
  "required": [
    "data",
    "total",
    "page",
    "page_size",
    "has_more"
  ]
}

400 Validation error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

500 Internal error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X GET https://identity.platform.loop.health/v1/admin/users \
  -H "Authorization: Bearer $ACCESS_TOKEN"