Contacts (API)

You can list, import, edit, and delete the workspace contact directory via the API.

Listing contacts

curl -H "x-api-key: YOUR_API_KEY" https://api.signi.com/api/v1/contacts/list

[
    {
        "contact_id": 123456,
        "fullname": "Jan Novák",
        "email": "jan.novak@email.cz",
        "firstname": "Jan",
        "lastname": "Novák"
    }
]

Importing contacts

Contacts are imported as a CSV file — the required columns are lastname and email, others (e.g. firstname, phone) are optional:

curl -X POST -H "x-api-key: YOUR_API_KEY" \
  https://api.signi.com/api/v1/contacts/import \
  -F "file=@contacts.csv"

What is returned:

{ "created": 1, "updated": 0, "skipped": 0, "skippedDupliciteEmail": 0 }

For large batches, use the asynchronous variant — the same call to POST /api/v1/contacts/import/async. It returns immediately:

{ "batchId": 123 }

You can then check the batch progress via GET /api/v1/contacts/import/123:

{ "id": 123, "type": "import", "status": "finished",
  "results": { "created": 1, "updated": 0, "skipped": 0, "createdContactIds": [123456] } }

Editing a contact

curl -X PATCH -H "x-api-key: YOUR_API_KEY" -H "Content-Type: application/json" \
  https://api.signi.com/api/v1/contacts/CONTACT_ID \
  -d '{ "firstname": "Petr" }'

Send only the fields you want to change.

Deleting a contact

curl -X DELETE -H "x-api-key: YOUR_API_KEY" \
  https://api.signi.com/api/v1/contacts/CONTACT_ID

Where to go next

• Multiple signers — information about people when creating a document
• Labels
• Reference documentation