GET
/
api
/
partner
/
users
Retrieve users
curl --request GET \
  --url https://backend.identifai.net/api/partner/users \
  --header 'X-Api-Key: <api-key>'
{
  "current_page": 1,
  "data": [
    {
      "id": 222,
      "name": "User",
      "email": "User@mail.com",
      "email_verified_at": "2025-03-03T13:28:03.000000Z",
      "address": null,
      "zip": null,
      "city": null,
      "country": null,
      "phone": null,
      "contact": null,
      "vat": null,
      "created_at": "2025-03-03T13:28:03.000000Z",
      "updated_at": "2025-03-12T09:32:43.000000Z",
      "balance": 0,
      "heuristic": "AverageExcludeObsolete",
      "readonly": null,
      "pricing": {
        "id": 1,
        "name": "TestB",
        "sku": "testB"
      },
      "partner": {
        "id": 221,
        "name": "Partner",
        "email": "Partner@gmail.com",
        "email_verified_at": "2025-03-03T11:22:49.000000Z",
        "address": null,
        "zip": null,
        "city": null,
        "country": null,
        "phone": null,
        "contact": null,
        "vat": null,
        "created_at": "2025-03-03T11:22:49.000000Z",
        "updated_at": "2025-03-03T13:27:06.000000Z",
        "balance": 0,
        "heuristic": "Average",
        "readonly": false,
        "pricing": {
          "id": 2,
          "name": "TestAC",
          "sku": "testAC"
        },
        "partner": null
      }
    }
  ],
  "from": 1,
  "last_page": 1,
  "next_page_url": null,
  "per_page": 100,
  "to": 1,
  "total": 1
}

Authorizations

ā€‹
X-Api-Key
string
header
required

Your API key.

Query Parameters

ā€‹
search
string

Filter users by name or email (partial match).

ā€‹
pricing_id
integer

Filter users by their pricing tier ID.

ā€‹
order
string
default:id

Specify the field to sort results by.

ā€‹
direction
enum<string>

Sorting direction: asc for ascending, desc for descending.

Available options:
desc,
asc
ā€‹
per_page
integer

Number of results per page. If omitted, all results are returned.

Response

200 - application/json

A paginated list of users matching the search criteria.

The response is of type object.