Skip to main content
GET
/
customers
Get all customers
curl --request GET \
  --url https://api.orafi.app/v1/customers \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "message": "Customers retrieved successfully",
  "data": [
    {
      "id": "customer_abc123",
      "firstname": "John",
      "lastname": "Doe",
      "email": "john.doe@example.com",
      "totalSpent": 500.5,
      "mode": "test",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.orafi.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for merchant authentication required for most endpoints

Query Parameters

​
mode
enum<string>

Filter by business mode

Available options:
test,
live
​
amountSpent
enum<string>

Filter by amount spent

Available options:
BELOW10USDT,
FROM10TO30USDT,
FROM30TO100USDT,
FROM100TO200USDT,
FROM200TO500USDT,
ABOVE500USDT
​
limit
integer

Number of records to return

​
cursor
string

Pagination cursor

Response

Customers retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Customers retrieved successfully"

​
data
object[]