Retrieves detailed information about a specific contact by its unique identifier. This endpoint is useful for viewing or validating contact data before creating or updating related entities. Ensure the provided contact ID exists in the system.
Request
Authorization
Add parameter in header
x-api-token
Example:
x-api-token: ********************
Path Params
contactId
string<uuid>
required
Contact ID
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request GET 'https://api.signater.com/v1/ecm/contacts/' \
--header'x-api-token;'
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
description
string|null
optional
Description of the contact
Example
{"id":"54e0112d-08dd-4efd-a033-d015046b3c66","name":"John Doe","role":"Confirm","title":"Company Director","email":"john.doe@example.com","phoneIdd":1,"phoneNumber":"5555555555","documentType":"GenericIdentification","documentValue":"123456789","description":"This is a description"}