1. Customers
Artha Payments API
  • Introduction
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Update Customer
      PATCH
  • Manage Account
    • Get Payout Currencies
      GET
    • Save Payout Currency
      POST
    • Update Payout Currency State
      PUT
  • Payees
    • Get Fiat Payees List (Grid)
      GET
    • View Fiat Payee Details
      GET
    • Get Recipient Form Fields
      GET
    • Get Payees Lookup Data
      GET
    • Get Phone Codes Lookup
      GET
    • Get Countries With States Lookup
      GET
    • Get Payee Countries
      GET
    • Get Currencies With Countries
      GET
    • Create Fiat Payee
      POST
    • Update Fiat Payee
      PUT
    • Update Payee State (Admin)
      PUT
  • Payout Screen
    • Get Merchant Crypto Payout Config
      GET
    • Get Active Fiat Payout Currencies
      GET
    • Get Fiat Payees
      GET
    • Get Payment Purposes
      GET
    • Get Source Of Funds
      GET
    • Payments Lookup (Core)
      GET
    • Get Transfer Types
      GET
    • Get Crypto Payout Fee
      POST
    • Create Crypto Payout
      POST
    • Payments Order Creation (Provider)
      POST
    • Get Crypto Payout Transactions
      GET
  1. Customers

List Customers

GET
/baseurl/api/v1/Customers
Last modified:2026-07-17 05:19:15
Returns a paginated list of all customers.

Request

Query Params

Header Params

Responses

🟢200
application/json
Bodyapplication/json

🟠401
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/baseurl/api/v1/Customers?limit=&offset=&status=&type=&search=&createdFrom=&createdTo=' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;'
Response Response Example
{
    "data": [
        {
            "id": "cst_789012",
            "type": "business",
            "firstName": null,
            "lastName": null,
            "email": "contact@acme.com",
            "phoneCode": "+91",
            "phoneNumber": "9123456789",
            "country": "India",
            "status": "Active",
            "businessName": "Acme Pvt Ltd",
            "createdAt": "2026-03-30T11:45:00Z"
        }
    ],
    "pagination": {
        "total": 1,
        "limit": 20,
        "offset": 0,
        "hasMore": false
    }
}
Modified at 2026-07-17 05:19:15
Previous
Create Customer
Next
Get Customer
Built with