API Test Keys

Fetch All Contacts

GET

/v1/contacts

Click to copy

Use this endpoint to retrieve the details of all contacts.

Is this page helpful?

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X GET https://api.razorpay.com/v1/contacts

Success

Failure

1{
2"entity": "collection",
3"count": 1,
4"items": [
5  {
6  "id": "cont_00000000000001",
7  "entity": "contact",
8  "name": "Gaurav Kumar",
9  "contact": "9000090000",
10  "email": "gaurav.kumar@example.com",
11  "type": "self",
12  "reference_id": "Acme Contact ID 12345",
13  "batch_id": null,
14  "active": true,
15  "notes": {
16    "notes_key_1":"Tea, Earl Grey, Hot",
17    "notes_key_2":"Tea, Earl Grey… decaf."
18  },
19  "created_at": 1545322986
20  }
21 ]
22}

Query Parameters

name

string

Name by which results should be filtered. For example, Gaurav.

email

string

Email address by which results should be filtered. For example, gaurav.kumar@example.com.

contact

string

Phone number by which results should be filtered. For example, 9000090000.

reference_id

string

The user-generated reference by which results should be filtered. For example, Acme Contact ID 12345. Maximum length is 40 characters.

active

boolean

The state by which results should be filtered. Possible values:

1: active
0: inactive

type

string

The classification by which results should be filtered. Possible values:

vendor
customer
employee
self

from

integer

Timestamp, in Unix, from when contacts are to be retrieved.

to

integer

Timestamp, in Unix, till when contacts are to be retrieved.

count

integer

The number of contacts to be retrieved. Default = 10. Maximum = 100. This can be used for pagination, in combination with skip.

skip

integer

The number of contacts to be skipped. Default = 0. This can be used for pagination, in combination with count.

Response Parameters

id

string

The unique identifier linked to the contact. For example, cont_00000000000001.

entity

string

The entity being created. Here, it is contact.

name

string

The contact's name. For example, Gaurav Kumar.

contact

string

The contact's phone number. For example, 9000090000.

email

string

The contact's email address. For example, gaurav.kumar@example.com.

type

string

A classification for the contact being created. For example, employee.

reference_id

string

A user-entered reference for the contact. For example, Acme Contact ID 12345.

batch_id

string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

active

boolean

Possible values:

true (default) : active
false : inactive

notes

object

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

created_at

integer

Timestamp, in Unix, when the contact was created. For example, 1545320320.

Errors

The name field is required.

Error Status: 4xx

The name field is missing in the request body.

Solution

The name field is invalid.

Error Status: 4xx

There are special characters used in the name field.

Solution

Invalid type: contact_typeA

Error Status: 4xx

There are special characters in the type field.
Casing does not match as per the type. type is case-sensitive.
Contact type sent in the request does not match the types present in the Dashboard.

Solution

Fetch All Contacts

GET

/v1/contacts

Click to copy

Use this endpoint to retrieve the details of all contacts.

Is this page helpful?

Query Parameters

name

string

Name by which results should be filtered. For example, Gaurav.

email

string

Email address by which results should be filtered. For example, gaurav.kumar@example.com.

contact

string

Phone number by which results should be filtered. For example, 9000090000.

reference_id

string

The user-generated reference by which results should be filtered. For example, Acme Contact ID 12345. Maximum length is 40 characters.

active

boolean

The state by which results should be filtered. Possible values:

1: active
0: inactive

type

string

The classification by which results should be filtered. Possible values:

vendor
customer
employee
self

from

integer

Timestamp, in Unix, from when contacts are to be retrieved.

to

integer

Timestamp, in Unix, till when contacts are to be retrieved.

count

integer

The number of contacts to be retrieved. Default = 10. Maximum = 100. This can be used for pagination, in combination with skip.

skip

integer

The number of contacts to be skipped. Default = 0. This can be used for pagination, in combination with count.

Response Parameters

id

string

The unique identifier linked to the contact. For example, cont_00000000000001.

entity

string

The entity being created. Here, it is contact.

name

string

The contact's name. For example, Gaurav Kumar.

contact

string

The contact's phone number. For example, 9000090000.

email

string

The contact's email address. For example, gaurav.kumar@example.com.

type

string

A classification for the contact being created. For example, employee.

reference_id

string

A user-entered reference for the contact. For example, Acme Contact ID 12345.

batch_id

string

This value is returned if the contact was created as part of a bulk upload. For example, batch_00000000000001.

active

boolean

Possible values:

true (default) : active
false : inactive

notes

object

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

created_at

integer

Timestamp, in Unix, when the contact was created. For example, 1545320320.

Errors

The name field is required.

Error Status: 4xx

The name field is missing in the request body.

Solution

The name field is invalid.

Error Status: 4xx

There are special characters used in the name field.

Solution

Invalid type: contact_typeA

Error Status: 4xx

There are special characters in the type field.
Casing does not match as per the type. type is case-sensitive.
Contact type sent in the request does not match the types present in the Dashboard.

Solution

Curl

1curl -u [YOUR_KEY_ID]:[YOUR_KEY_SECRET] \
2-X GET https://api.razorpay.com/v1/contacts

Success

Failure

1{
2"entity": "collection",
3"count": 1,
4"items": [
5  {
6  "id": "cont_00000000000001",
7  "entity": "contact",
8  "name": "Gaurav Kumar",
9  "contact": "9000090000",
10  "email": "gaurav.kumar@example.com",
11  "type": "self",
12  "reference_id": "Acme Contact ID 12345",
13  "batch_id": null,
14  "active": true,
15  "notes": {
16    "notes_key_1":"Tea, Earl Grey, Hot",
17    "notes_key_2":"Tea, Earl Grey… decaf."
18  },
19  "created_at": 1545322986
20  }
21 ]
22}