Référence de l'API

Contacts

Le carnet d'adresses de votre espace de travail. Les personnes à qui vous envoyez y sont ajoutées automatiquement.

Points de terminaison · 5

POST Créer un contact
GET Récupérer un contact
GET Lister les contacts
PATCH Mettre à jour un contact
DELETE Supprimer un contact

L'objet

Champ	Saisir	Description
`id`	string	Identifiant unique, commençant par con_.
`object`	string	Toujours "contact".
`name, email, company`	string
`locale`	enum	en ou fr.
`last_sent_at`	timestamp ou null	La dernière fois que vous lui avez envoyé quelque chose.
`created_at`	timestamp

POST/contacts

Créer un contact

Paramètre	Saisir		Description
`name`	string	obligatoire
`email`	string	obligatoire	Unique dans l'espace de travail.
`company`	string	facultatif
`locale`	enum	facultatif	en (par défaut) ou fr.

Requête

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" }'

Réponse

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}

Récupérer un contact

Requête

bash

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

Réponse

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

Lister les contacts

Les plus récents d'abord.

Paramètre	Saisir		Description
`limit`	integer	facultatif	Nombre d'objets à renvoyer, de 1 à 100. Par défaut 20.
`starting_after`	string	facultatif	Le next_cursor de la page précédente. Omettez-le pour la première page.
`q`	string	facultatif	Recherche dans les noms et les courriels.

Requête

bash

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

Réponse

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}

Mettre à jour un contact

Paramètre	Saisir		Description
`name, email, company, locale`		facultatif

Requête

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." }'

Réponse

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}

Supprimer un contact

Les documents déjà envoyés ne changent pas.

Requête

bash

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

Réponse

json

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