Introduction

API Reference Guide

API Changelog

API Basics

Authentication & Sandbox Setup

Entity & Metadata

Pagination & Rate Limiting

Best Practices

Glossary

Payments

Orders

Payments

Downtime

Settlements

Instant Settlements

Refunds

Disputes

Documents

Customers

Payment Links

QR Codes

Invoices

Items

Plans

Subscriptions

Add-on

Linked Account

Stakeholder

Product Configuration

Transfers

Smart Collect

Smart Collect With TPV

Bills

About Bills

Bills Entity

Create a Bill

Update a Bill

Delete a Bill

Partners

Account

Product Configuration

Stakeholder

Terms and Conditions

Documents

Webhooks

Payout APIs

Get Started

Account Validation

Composite Account Validation

Contacts

Fund Accounts

Payouts

Payouts to Cards

Payout Composite

Payouts Approval

Payout Idempotency

Payout Links

Payout Wallet - Amazon

Transactions

Api

Customers

Fetch All

API Test Keys

Fetch All Customers

GET
/v1/customers

Click to copy

Use this endpoint to retrieve the details of all the customers.

Is this page helpful?

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X GET https://api.razorpay.com/v1/customers?count=2&skip=1

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 2,
4
  "items": [
5
    {
6
      "id": "cust_LQPdeJqQeKQrJM",
7
      "entity": "customer",
8
      "name": "Gaurav Kumar",
9
      "email": null,
10
      "contact": "+919876543210",
11
      "gstin": null,
12
      "notes": [],
13
      "created_at": 1678580352
14
    },
15
    {
16
      "id": "cust_LQPd9lomgwDE5F",
17
      "entity": "customer",
18
      "name": "Saurav Kumar",
19
      "email": "saurav.kumar@example.com",
20
      "contact": "+919876543210",
21
      "gstin": null,
22
      "notes": [],
23
      "created_at": 1678580324
24
    }
25
  ]
26
}
Query Parameters
count
integer

The number of customer records to be retrieved from the system. The default value is 10. The maximum value is 100. This can be used for pagination in combination with skip.

skip
integer

The number of customer records that must be skipped. The default value is 0. This can be used for pagination in combination with count.

Response Parameters
entity
string

Indicates the type of entity.

id
string

Unique identifier of the customer. For example, cust_1Aa00000000004.

name
string

Customer's name. Alphanumeric, with period (.), apostrophe ('), forward slash (/), at (@) and parentheses allowed. The name must be between 3-50 characters in length. For example, Gaurav Kumar.

contact
string

The customer's phone number. A maximum length of 15 characters including country code. For example, +919876543210.

email
string

The customer's email address. A maximum length of 64 characters. For example, gaurav.kumar@example.com.

gstin
string

GST number linked to the customer. For example, 29XAbbA4369J1PA.

notes
string

This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at
integer

UNIX timestamp, when the customer was created. For example, 1234567890.

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard. Possible reasons:

  • Different keys for test mode and live modes.
  • Expired API key.

Solution

Fetch All Customers

GET
/v1/customers

Click to copy

Use this endpoint to retrieve the details of all the customers.

Is this page helpful?

Query Parameters
count
integer

The number of customer records to be retrieved from the system. The default value is 10. The maximum value is 100. This can be used for pagination in combination with skip.

skip
integer

The number of customer records that must be skipped. The default value is 0. This can be used for pagination in combination with count.

Response Parameters
entity
string

Indicates the type of entity.

id
string

Unique identifier of the customer. For example, cust_1Aa00000000004.

name
string

Customer's name. Alphanumeric, with period (.), apostrophe ('), forward slash (/), at (@) and parentheses allowed. The name must be between 3-50 characters in length. For example, Gaurav Kumar.

contact
string

The customer's phone number. A maximum length of 15 characters including country code. For example, +919876543210.

email
string

The customer's email address. A maximum length of 64 characters. For example, gaurav.kumar@example.com.

gstin
string

GST number linked to the customer. For example, 29XAbbA4369J1PA.

notes
string

This is a key-value pair that can be used to store additional information about the entity. It can hold a maximum of 15 key-value pairs, 256 characters (maximum) each. For example, "note_key": "Beam me up Scotty”.

created_at
integer

UNIX timestamp, when the customer was created. For example, 1234567890.

Errors

The API <key/secret> provided is invalid.

Error Status: 4xx

The API credentials passed in the API call differ from the ones generated on the Dashboard. Possible reasons:

  • Different keys for test mode and live modes.
  • Expired API key.

Solution

Curl

change language

change language

1
curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2
-X GET https://api.razorpay.com/v1/customers?count=2&skip=1

Success

Failure

1
{
2
  "entity": "collection",
3
  "count": 2,
4
  "items": [
5
    {
6
      "id": "cust_LQPdeJqQeKQrJM",
7
      "entity": "customer",
8
      "name": "Gaurav Kumar",
9
      "email": null,
10
      "contact": "+919876543210",
11
      "gstin": null,
12
      "notes": [],
13
      "created_at": 1678580352
14
    },
15
    {
16
      "id": "cust_LQPd9lomgwDE5F",
17
      "entity": "customer",
18
      "name": "Saurav Kumar",
19
      "email": "saurav.kumar@example.com",
20
      "contact": "+919876543210",
21
      "gstin": null,
22
      "notes": [],
23
      "created_at": 1678580324
24
    }
25
  ]
26
}