Listar listas de leads

GET

/lists

curl --request GET \
  --url https://dattacrm.com.br/api/v1/lists \
  --header 'Authorization: Bearer <token>'

Lista as listas de leads da conta, com a pasta de cada uma, o total de leads e, nas listas com funil, as etapas (use os ids como stageId em update_lead_in_list). Um lead pode estar em várias listas.

Authorizations

• bearerAuth

Responses

200

Sucesso.

Media type application/json

object

data

required

Listas da conta, por pasta e depois por nome.

Array<object>

Lista de leads da conta.

object

id

required

Identificador da lista.

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

Nome da lista.

string

isDefault

required

Obsoleto: não há mais lista padrão. Sai numa versão futura.

boolean

folderId

required

Identificador da pasta da lista.

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

folderName

required

Nome da pasta da lista.

string

count

required

Quantos leads estão na lista.

integer

>= -9007199254740991 <= 9007199254740991

hasFunnel

required

Verdadeiro quando a lista tem funil (listas de WhatsApp e Instagram). Lista de Site não tem etapas.

boolean

stages

required

Etapas do funil da lista, na ordem do quadro (ativas, depois Ganho e Perdido). Vazio quando não há funil.

Array<object>

Etapa do funil de uma lista.

object

id

required

Identificador da etapa. É o valor aceito como stageId em update_lead_in_list.

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

name

required

Nome da etapa.

string

kind

required

Tipo da etapa: active (em andamento), won (ganho) ou lost (perdido).

string

Allowed values: active won lost

position

required

Posição da etapa no funil da lista (1 é a primeira).

integer

>= -9007199254740991 <= 9007199254740991

Example

{
  "data": [
    {
      "id": "0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f",
      "folderId": "0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f",
      "stages": [
        {
          "id": "0b6f3c1e-8a4d-4f5b-9c2e-1a2b3c4d5e6f",
          "kind": "active"
        }
      ]
    }
  ]
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

X-RateLimit-Limit

integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining

integer

Requisições restantes na janela atual.

X-RateLimit-Reset

integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

400

Dados inválidos na requisição (validation_error), lead novo sem lista (list_required), campo que mudou de lugar (field_moved) ou chave enviada na URL (api_key_in_url).

Media type application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

401

Chave ausente, inválida (invalid_api_key), vencida (api_key_expired) ou revogada (api_key_revoked).

Media type application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

429

Limite de requisições atingido (rate_limited). Aguarde Retry-After segundos.

Media type application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.

X-RateLimit-Limit

integer

Máximo de requisições por janela de 60 segundos para esta chave.

X-RateLimit-Remaining

integer

Requisições restantes na janela atual.

X-RateLimit-Reset

integer

Fim da janela atual, em milissegundos desde a época Unix (epoch ms).

Retry-After

integer

Segundos até poder tentar de novo.

500

Erro interno (internal_error). Informe o requestId ao suporte.

Media type application/json

Formato de erro da API.

object

error

required

object

code

required

Código estável do erro, ex.: validation_error.

string

message

required

Mensagem legível em português.

string

details

Detalhes extras, ex.: lista de campos inválidos.

requestId

required

Identificador da requisição, para suporte.

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example",
    "requestId": "example"
  }
}

Headers

X-Request-Id

string

Identificador da requisição, para suporte.