GET
/
users
List users
curl --request GET \
  --url https://api.paygentic.io/v0/users \
  --header 'Authorization: Bearer <token>'
{
  "users": [
    {
      "id": "<string>",
      "object": "user",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "jsmith@example.com",
      "oryId": "<string>",
      "address": {
        "line1": "<string>",
        "line2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "zipCode": "<string>"
      },
      "phone": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "organization": "<string>",
      "type": "COMPANY",
      "dateOfBirth": "2023-12-25"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
email
string<email>

Email address of the user to filter the search results.

​
oryId
string

Unique identifier for the user in the ORY system.

​
organization
string

ID of the organization to filter users by.

Response

200
application/json

List of users matching the search criteria

The response is of type object.