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

Contact

Last modified:2025-03-29 12:47:42

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

IsFavorite

boolean

optional

Filter contacts by favorite status

string

optional

Search contacts by id, name, email, or description

PageSize

integer <int32>

required

Number of items per page

>= 1<= 100

Default:

PageNumber

integer <int32>

required

Current page number

>= 1<= 4294967295

Default:

OrderByDirection

enum<string>

required

Order by direction

Allowed values:

ASCDESC

Default:

DESC

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Contacts listed successfully

Body

items

array[object (ListContactsApiResponseItem) {16}] | null

optional

List of contacts

string <uuid>

optional

Id of the contact

createdAtUtc

string <date-time>

optional

Date and time when the contact was created (UTC)

createdByName

string | null

optional

Name of the user who created the contact

createdByAvatar

string | null

optional

Url Avatar of the user who created the contact

updatedAtUtc

string <date-time>

optional

Date and time when the contact was last updated (UTC)

updatedByName

string | null

optional

Name of the user who last updated the contact

updatedByAvatar

string | null

optional

Url Avatar of the user who last updated the contact

name

string | null

optional

Name of the contact

role

enum<string> | enum<null>

optional

Role of the contact

Allowed values:

SignApproveRecognizeTestifyConfirmReceivingEndorseInBlackEndorseInWhiteConfirm

title

string | null

optional

Title of the contact

string | null

optional

Email address of the contact

phoneIdd

integer <int32> | null

optional

Phone IDD of the contact, e.g. '1' for the United States or '55' for Brazil

phoneNumber

string | null

optional

Phone number of the contact excluding the IDD

documentType

enum<string> | enum<null>

optional

Document type of the contact

Allowed values:

GenericIdentificationBrazilianCpf

documentValue

string | null

optional

Document value of the contact

isFavorite

boolean

optional

Description of the contact

pagination

null | allOf {1}

optional

Pagination metadata

object (Pagination)

optional

Pagination metadata

Example

{
  "items": [
    {
      "id": "071891b2-49b2-48e1-83b7-4acb48e29749",
      "createdAtUtc": "2025-03-29T12:47:40.1917427Z",
      "createdByName": "John Doe",
      "createdByAvatar": "https://example.com/avatar.jpg",
      "updatedAtUtc": "2025-03-29T12:47:40.1917429Z",
      "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 2025-03-29 12:47:42

Error handling

Create contact