v1

latestOpenAPI 3.0.02026-07-24126202516.7 KB
Users

List Users

Retrieve an ordered and paginated list of existing Users.

get/users

Query parameters

limitinteger

Number of records to retrieve. Up to 200.

offsetinteger

Number of records to offset. Required for pagination.

searchstring required

A text value to be used for searching users

Response

OK

Example response

{
  "users": [
    {
      "full_name": "Samuel Seller",
      "email": "samuel.seller@assemblypayments.com",
      "first_name": "Samuel",
      "last_name": "Seller",
      "id": "Seller_1234",
      "location": "AUS",
      "verification_status": "pending",
      "roles": [
        "customer"
      ],
      "dob": "encrypted",
      "government_number": "encrypted",
      "related": {
        "addresses": "fe602dcf-4175-4f88-b5be-3beb04092dcd"
      }
    }
  ]
}