GET
/
auth
/
users
curl --request GET \
  --url https://api.pxyz.dev/api/v0/auth/users
{
  "status": "success",
  "data": [
    {
      "id": "<string>",
      "tenantId": "<string>",
      "name": "<string>",
      "imageUri": "<string>",
      "lastSignInAt": "2023-11-07T05:31:56Z",
      "lastActiveAt": "2023-11-07T05:31:56Z",
      "username": "<string>",
      "status": "active",
      "roleId": "<string>",
      "role": {
        "id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "permissions": [
          "<string>"
        ]
      },
      "primaryEmailId": "<string>",
      "primaryPhoneId": "<string>",
      "emailAddresses": [
        {
          "id": "<string>",
          "tenantId": "<string>",
          "userId": "<string>",
          "email": "jsmith@example.com",
          "verifiedAt": "2023-11-07T05:31:56Z",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "phoneNumbers": [
        {
          "id": "<string>",
          "tenantId": "<string>",
          "userId": "<string>",
          "phone": "<string>",
          "verifiedAt": "2023-11-07T05:31:56Z",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "publicMeta": "<any>",
      "privateMeta": "<any>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "total": 123,
    "count": 123,
    "numPages": 123,
    "perPage": 123,
    "prev": "2023-11-07T05:31:56Z",
    "next": "2023-11-07T05:31:56Z"
  }
}

Query Parameters

tenantId
string
required
cursor
string
perPage
string

Response

200 - application/json
status
enum<string>
required
Available options:
success,
error
data
object[]
required
meta
object
required