Skip to main content
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": 123,
  "data": [
    {
      "id": 123,
      "name": "<string>",
      "email": "[email protected]",
      "email_verified_at": "2023-11-07T05:31:56Z",
      "address": "<string>",
      "zip": "<string>",
      "city": "<string>",
      "country": "<string>",
      "phone": "<string>",
      "contact": "<string>",
      "vat": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "balance": 123,
      "heuristic": "<string>",
      "readonly": true,
      "pricing": {
        "id": 123,
        "name": "<string>",
        "sku": "<string>"
      },
      "partner": "<unknown>"
    }
  ],
  "from": 123,
  "last_page": 123,
  "next_page_url": "<string>",
  "per_page": 123,
  "to": 123,
  "total": 123
}

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

A paginated list of users matching the search criteria.

​
current_page
integer

Current page number

​
data
object[]

List of users on the current page

​
from
integer

First user index on the current page

​
last_page
integer

Total number of pages

​
next_page_url
string<uri>

URL of the next page (if available)

​
per_page
integer

Number of users per page

​
to
integer

Last user index on the current page

​
total
integer

Total number of users