Skip to main content
GET
/
api
/
v1
/
csp
/
customer
Search Customers
curl --request GET \
  --url https://sandbox.api.paylias.xyz/gateway/api/v1/csp/customer \
  --header 'X-PAYLIAS-API-KEY: <api-key>' \
  --header 'x-org-id: <x-org-id>' \
  --header 'x-partner-id: <x-partner-id>'
{
  "data": {
    "count": 1,
    "customers": [
      {
        "created_at": {
          "seconds": 1743092228
        },
        "first_name": "Ziyad",
        "last_name": "Parekh",
        "nick_name": "ziyad",
        "partner_id": "part_ct23b6420or249k5boag",
        "payment_address": "ziyadparekh@safepay-platinum",
        "status": 2,
        "token": "cust_cvink1420or763mhjesg",
        "updated_at": {
          "seconds": 1743092228
        }
      }
    ]
  },
  "ok": true
}

Authorizations

​
X-PAYLIAS-API-KEY
string
header
required

Headers

​
x-org-id
string
default:""
required

The Organization ID header used for authorization

​
x-partner-id
string
default:""
required

The Partner ID header used for authorization

Query Parameters

​
tokens
string
Example:

""

​
first_names
string
Example:

"Ziyad"

​
middle_names
string
Example:

""

​
last_names
string
Example:

""

​
nick_names
string
Example:

""

​
payment_addresses
string
Example:

"ziyadparekh@safepay-platinum"

​
limit
string
Example:

"10"

​
page
string
Example:

"1"

​
status
enum<string>
Available options:
ENABLED,
DISABLED
Example:

"ENABLED"

Response

Response containing list of customers

Standard response structure for successful operations

​
ok
boolean

Indicates if the operation was successful

Example:

true

​
data
object

Contains the response data

⌘I