v1

latestOpenAPI 3.0.32026-07-2431396640.5 KB

crm-v1-organizations

Listar contatos da empresa

get/organizations/{organization_id}/contacts

Path parameters

organization_idstring required

ID da empresa.

Query parameters

pagestring

Example:1

Número atual da página

limitstring

Example:20

Limite de empresas que virão por listagem. Valor padrão é 20. Valor máximo é 200

Response

Success

has_moreboolean

totalnumber

Example response

{
  "contacts": [
    {
      "_id": "6400916fa6c93a000ce8ef06",
      "contact_custom_fields": [
        {
          "_id": "6400917ca6c93a000ce8ef18",
          "custom_field_id": "63e39c3b50bc830014f86c21"
        }
      ],
      "created_at": "2023-03-02T09:07:11.305-03:00",
      "id": "ID",
      "legal_bases": [
        {
          "category": "communications",
          "status": "granted",
          "type": "pre_existent_contract"
        }
      ],
      "name": "NAME",
      "organization_id": "64000daccb9f8f000c5d9cbb",
      "phones": [
        {
          "phone": "4444444",
          "type": "work",
          "whatsapp_full_internacional": "+4444444",
          "whatsapp_url_web": "https://web.whatsapp.com/send?phone=4444444&text=Ol%C3%A1%2C%20gostaria%20de%20tomar%20um%20caf%C3%A9%3F"
        }
      ],
      "updated_at": "2023-03-02T09:07:24.108-03:00"
    }
  ],
  "total": 1
}