API reference

Contacts

Your workspace’s address book. People you send to are added automatically.

Endpoints · 5

POST Create a contact
GET Retrieve a contact
GET List contacts
PATCH Update a contact
DELETE Delete a contact

The object

Field	Type	Description
`id`	string	Unique ID, starting with con_.
`object`	string	Always "contact".
`name, email, company`	string
`locale`	enum	en or fr.
`last_sent_at`	timestamp or null	When you last sent them something.
`created_at`	timestamp

POST/contacts

Create a contact

Parameter	Type		Description
`name`	string	required
`email`	string	required	Unique in the workspace.
`company`	string	optional
`locale`	enum	optional	en (default) or fr.

Request

bash

curl -X POST "https://api.esorasign.com/v1/contacts" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Maya Chen", "email": "maya.chen@example.com", "company": "Northwind Traders" }'

Response

json

{
  "id": "con_4HUig43kiJfahqSIjOugM1",
  "object": "contact",
  "name": "Maya Chen",
  "email": "maya.chen@example.com",
  "company": "Northwind Traders",
  "locale": "en",
  "last_sent_at": "2026-11-02T14:05:11.000Z",
  "created_at": "2026-09-30T10:12:40.000Z"
}

GET/contacts/{id}

Retrieve a contact

Request

bash

curl "https://api.esorasign.com/v1/contacts/con_4HUig43kiJfahqSIjOugM1" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{
  "id": "con_4HUig43kiJfahqSIjOugM1",
  "object": "contact",
  "name": "Maya Chen",
  "email": "maya.chen@example.com",
  "company": "Northwind Traders",
  "locale": "en",
  "last_sent_at": "2026-11-02T14:05:11.000Z",
  "created_at": "2026-09-30T10:12:40.000Z"
}

GET/contacts

List contacts

Newest first.

Parameter	Type		Description
`limit`	integer	optional	How many objects to return, 1 to 100. Default 20.
`starting_after`	string	optional	The next_cursor from the previous page. Leave it out for the first page.
`q`	string	optional	Search names and emails.

Request

bash

curl "https://api.esorasign.com/v1/contacts?q=chen" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{
  "object": "list",
  "data": [
    {
      "id": "con_4HUig43kiJfahqSIjOugM1",
      "object": "contact",
      "name": "Maya Chen",
      "email": "maya.chen@example.com",
      "company": "Northwind Traders",
      "locale": "en",
      "last_sent_at": "2026-11-02T14:05:11.000Z",
      "created_at": "2026-09-30T10:12:40.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

PATCH/contacts/{id}

Update a contact

Parameter	Type		Description
`name, email, company, locale`		optional

Request

bash

curl -X PATCH "https://api.esorasign.com/v1/contacts/con_4HUig43kiJfahqSIjOugM1" \
  -H "Authorization: Bearer $ESORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "company": "Northwind Traders Ltd." }'

Response

json

{
  "id": "con_4HUig43kiJfahqSIjOugM1",
  "object": "contact",
  "name": "Maya Chen",
  "email": "maya.chen@example.com",
  "company": "Northwind Traders",
  "locale": "en",
  "last_sent_at": "2026-11-02T14:05:11.000Z",
  "created_at": "2026-09-30T10:12:40.000Z"
}

DELETE/contacts/{id}

Delete a contact

Documents already sent are not affected.

Request

bash

curl -X DELETE "https://api.esorasign.com/v1/contacts/con_4HUig43kiJfahqSIjOugM1" \
  -H "Authorization: Bearer $ESORA_API_KEY"

Response

json

{ "id": "con_4HUig43kiJfahqSIjOugM1", "object": "contact", "deleted": true }