Listar contatos da agenda

📘
Requisição para listar contatos da agenda na Clicksign. Esta é uma requisição GET para /api/v2/contacts?page=number&, sendo number o número da página. Os atributos do contato aparecerão no body.

Contacts: atributos dos contatos da agenda

Atributo	Descrição	Exemplo
`name`	Nome do contato.	Paulo Silva
`email`	E-mail do contato.	[email protected]
`favorites`	Indica se o contato está marcado como favorito.	true
`inactive`	Indica se o contato está inativo.	false

Page_infos: atributos de listagem das páginas

📘
São listados até 30 contatos por página

Atributo	Descrição	Exemplo
`total_pages`	Quantidade total de páginas.	3
`current_page`	Número da página que está sendo visualizada.	1
`next_page`	Número da próxima página que será visualizada.	2
`prev_page`	Número da página anterior.	null
`first_page?`	Determina se é a primeira página da listagem.	true
`last_page?`	Determina se é a última página da listagem.	false

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo completo

Request

GET /api/v2/contacts?access_token={{access_token}} HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/json
Accept: application/json

Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "contacts": [
        {
            "name": "Paulo Silva",
            "email": "[email protected]",
            "favorite": false,
            "phone_number": null,
            "documentation": "",
            "birthday": null,
            "auths": [
                "email"
            ],
            "communicate_by": "email",
            "has_documentation": true,
            "official_document_enabled": false,
            "selfie_enabled": false,
            "liveness_enabled": false,
            "handwritten_enabled": false,
            "facial_biometrics_enabled": false,
            "deleted_at": null,
            "created_at": "2022-12-06T14:18:03.908-03:00",
            "updated_at": "2022-12-06T14:18:03.908-03:00"
        }
    ],
    "page_infos": {
        "total_pages": 1,
        "current_page": 1,
        "next_page": null,
        "prev_page": null,
        "first_page?": true,
        "last_page?": true
    }
}