Admin api customers
Lists all customers
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
minCreatedAt?string
Format
date-timemaxCreatedAt?string
Format
date-timeminUpdatedAt?string
Format
date-timemaxUpdatedAt?string
Format
date-timeexternalId?string
If provided filters result list by externalId(s)
email?string
If provided filters result list by email(s)
paymentInstrumentProviderId?string
If provided filters result list by id(s) of a payment instrument, associated with the resulting record, specified exactly as in payment provider's system
Response Body
application/json
application/json
curl -X GET "https://oasis-api.public.sandbox.oasis.aifi.com/api/admin/v2/customers?minCreatedAt=2024-09-22T00%3A00%3A00.000Z&maxCreatedAt=2024-09-29T00%3A00%3A00.000Z&minUpdatedAt=2024-09-23T00%3A00%3A00.000Z&maxUpdatedAt=2024-09-30T00%3A00%3A00.000Z"[
{
"id": 0,
"externalId": "string",
"role": "customer",
"metadata": {
"arbitraryKey": "arbitraryValue"
},
"priority": 0,
"email": "user@example.com",
"firstName": "string",
"lastName": "string",
"phone": "string"
}
]Empty
{
"message": "Invalid request body",
"type": "E_INVALID_BODY",
"errors": [
{
"error": "\"email\" is required",
"rule": "any.required",
"field": "\"email\""
}
]
}How is this guide?