Documentation - Search signature

Search signature

Requête

Recherche des objets Signature associés au compte client. Différents filtres peuvent être fournis dans la query string afin d'affiner la recherche. Ces filtres sont cumulatifs, les résultats retournés satisferont chacun d'entre eux.

GET /api/signatures?data=123456
Authentication: Bearer cle+api+du+compte+client

Query string de la requête

• search
  optionnel
  
  Recherche dans la description de l'objet Signature, ou dans le nom, la société, l'adresse E-mail ou le numéro de téléphone du signataire associé.
• data
  optionnel
  
  Recherche dans la valeur clientData de l'objet Signature.
• uniqueid
  optionnel
  
  Recherche exacte de l'attribut signature.unique-identifier de l'objet Signature.
• maxcount
  optionnel
  
  Quantité maximale d'objet Signature à retourner.
• offset
  optionnel
  
  Commence à retourner les objets Signature à partir de cette position.
• details
  optionnel
  
  Détails des objets Signature à retourner.

Réponse

200 OK
Content-Type: application/json

{
	"success": true,
	"signatures": [
		{
			"description": "Contrat à signer",
			"token": "rKQ9qljTcXdynOzxBCnzfi3cWuqNDQl0",
			"creationDate": "2024-12-23T20:20:23+01:00",
			"allowedMethods": "email,touch",
			"signatoryName": "Pascal Dupont",
			"signatoryCompany": null,
			"signatoryEmail": "pascal.dupont@laposte.fr",
			"signatoryMobile": "+336123456789",
			"notificationUrl": "https://erp.client.org/sigtool/document-signed,mailto:notification@client.org",
			"redirectionUrl": null
		}
	],
	"truncated": false
}

Valeurs de la réponse

• signatures
  0..n
  
  Tableau de représentation JSON d'objets Signature du même type que celui retourné par l'API Add signature, en fonction du paramètre query string optionnel details.
• truncated
  obligatoire
  
  Retourne true si le nombre d'objets Signature a été tronqué pour respecter le filtre maxcount.