crm-v1-contacts

Listar contatos

get/contacts

Request

Base URL
https://crm.rdstation.com/api/v1
URL
https://crm.rdstation.com/api/v1/contacts
Auth
API key in query parameter token

Query parameters

pagestring

Número atual da página

limitstring

Limite de contatos que serão listados. Valor padrão é 20. Valor máximo é 200

orderstring

Campo a ser ordenado. Valor padrão é "name"

directionstring

Ordenação da lista. "asc" ou "desc", padrão é "asc"

emailstring

Filtra os resultados pelo email informado

qstring

Nome do contato a ser buscado

phonestring

Filtra os resultados pelo telefone informado

titlestring

Filtra os resultados pelo cargo informado

Response

Success

has_moreboolean

totalnumber

Example response

{
  "contacts": [
    {
      "_id": "62bef505b1b6e300209c91f4",
      "contact_custom_fields": [
        {
          "_id": "63beb0bd710cac001ce30a6d",
          "custom_field_id": "60dcc845f69fae0016b79f53"
        }
      ],
      "created_at": "2022-07-01T10:22:13.212-03:00",
      "deals": [
        {
          "_id": "62bef50ab1b6e300209c9230",
          "id": "62bef50ab1b6e300209c9230",
          "name": " 11 97173-0783"
        }
      ],
      "emails": [
        {
          "_id": "63beb0bd710cac001ce30a8b",
          "email": "contato@gerencial.com.br"
        }
      ],
      "id": "62bef505b1b6e300209c91f4",
      "legal_bases": [
        {
          "category": "data_processing",
          "status": "granted",
          "type": "pre_existent_contract"
        }
      ],
      "name": " 11 97173-0783",
      "organization_id": "62fba8d1b633c1000ee219ac",
      "phones": [
        {
          "phone": "+5511971730783",
          "type": "work",
          "whatsapp": true,
          "whatsapp_full_internacional": "+55 11 97173-0783",
          "whatsapp_url_web": "https://web.whatsapp.com/send?phone=5511971730783&text=Ol%C3%A1%2C%20gostaria%20de%20tomar%20um%20caf%C3%A9%3F"
        }
      ],
      "title": "Gerente 1",
      "updated_at": "2023-01-11T09:51:09.210-03:00"
    }
  ],
  "has_more": true,
  "total": 5115
}

Changes

No recorded changes to this operation across all 1 revision of this API.