This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock

List contacts

GET

https://api.signater.com/v1/ecm/contacts

Last modified:2026-02-13 00:19:57

Retrieves a list of contacts stored in the system. Contacts serve as a tool to streamline the creation of signers, allowing you to reuse previously registered information without needing to input it from scratch.

Request

Authorization

Add parameter in header

x-api-token

Example:

x-api-token: ********************

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://api.signater.com/v1/ecm/contacts?IsFavorite&Search&PageSize&PageNumber&OrderByDirection' \
--header 'x-api-token: <api-key>'

Responses

🟢200OK

application/json

Contacts listed successfully

Body

Example

{
    "items": [
        {
            "id": "260b76d7-51d4-4c0f-ba4c-9bbe4afb2d59",
            "createdAtUtc": "2026-02-13T00:19:55.9075012Z",
            "createdByName": "John Doe",
            "createdByAvatar": "https://example.com/avatar.jpg",
            "updatedAtUtc": "2026-02-13T00:19:55.9075013Z",
            "updatedByName": "John Doe",
            "updatedByAvatar": "https://example.com/avatar.jpg",
            "name": "John Doe",
            "role": "Confirm",
            "title": "Company Director",
            "email": "john.doe@example.com",
            "phoneIdd": 1,
            "phoneNumber": "5555555555",
            "documentType": "GenericIdentification",
            "documentValue": "123456789",
            "isFavorite": true
        }
    ],
    "pagination": {
        "totalItems": 1,
        "pageSize": 10,
        "pageNumber": 1,
        "pageItems": 1
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Modified at 2026-02-13 00:19:57

Error handling

Create contact