Lista leads por meio da chave de integracao

curl --request GET \
  --url https://api.wegly.com/v1/integrations/external/leads \
  --header 'Authorization: Bearer <token>'

{
  "total": 123,
  "records": [
    {
      "id": "<string>",
      "code": 123,
      "title": "<string>",
      "status": 123,
      "stage": {
        "id": "<string>",
        "name": "<string>",
        "pipeline": {
          "id": "<string>",
          "name": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by_user": {
        "id": "<string>",
        "name": "<string>",
        "avatar": "<string>"
      },
      "responsible": {
        "id": "<string>",
        "name": "<string>",
        "avatar": "<string>"
      },
      "person": {
        "id": "<string>",
        "name": "<string>"
      },
      "lead_source": {
        "id": "<string>",
        "name": "<string>",
        "logo": "<string>"
      },
      "quality_rating": 3,
      "quality_reason": "<string>",
      "visibility": 123,
      "value": 123,
      "tags": [
        {
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "pending_tasks_status": "NONE",
      "crm_task": [
        {
          "id": "<string>",
          "title": "<string>",
          "description": "<string>",
          "priority": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "crm_task_type": {
            "id": "<string>",
            "name": "<string>",
            "icon": "<string>"
          }
        }
      ],
      "negotiation_mode": "<string>",
      "archived_at": "2023-11-07T05:31:56Z",
      "won_date": "2023-11-07T05:31:56Z",
      "lost_date": "2023-11-07T05:31:56Z",
      "last_activity_at": "2023-11-07T05:31:56Z",
      "views_count": 123
    }
  ]
}

GET

integrations

external

leads

Lista leads por meio da chave de integracao

curl --request GET \
  --url https://api.wegly.com/v1/integrations/external/leads \
  --header 'Authorization: Bearer <token>'

{
  "total": 123,
  "records": [
    {
      "id": "<string>",
      "code": 123,
      "title": "<string>",
      "status": 123,
      "stage": {
        "id": "<string>",
        "name": "<string>",
        "pipeline": {
          "id": "<string>",
          "name": "<string>"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "created_by_user": {
        "id": "<string>",
        "name": "<string>",
        "avatar": "<string>"
      },
      "responsible": {
        "id": "<string>",
        "name": "<string>",
        "avatar": "<string>"
      },
      "person": {
        "id": "<string>",
        "name": "<string>"
      },
      "lead_source": {
        "id": "<string>",
        "name": "<string>",
        "logo": "<string>"
      },
      "quality_rating": 3,
      "quality_reason": "<string>",
      "visibility": 123,
      "value": 123,
      "tags": [
        {
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "pending_tasks_status": "NONE",
      "crm_task": [
        {
          "id": "<string>",
          "title": "<string>",
          "description": "<string>",
          "priority": 123,
          "start_date": "2023-11-07T05:31:56Z",
          "crm_task_type": {
            "id": "<string>",
            "name": "<string>",
            "icon": "<string>"
          }
        }
      ],
      "negotiation_mode": "<string>",
      "archived_at": "2023-11-07T05:31:56Z",
      "won_date": "2023-11-07T05:31:56Z",
      "lost_date": "2023-11-07T05:31:56Z",
      "last_activity_at": "2023-11-07T05:31:56Z",
      "views_count": 123
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

string

Busca livre por titulo ou codigo do lead.

skip

integer

default:0

Numero de registros ignorados antes da pagina atual (default 0).

Required range: x >= 0

take

integer

default:10

Quantidade maxima de registros retornados (default 10).

Required range: x >= 1

status

enum<integer>

Filtra pelo status do lead: 1=Aberto, 2=Ganho, 3=Perdido (0 ignora).

Available options:

0,

1,

2,

3

stage_id

string<uuid>

ID da etapa para filtrar os leads.

pipeline_id

string<uuid>

ID do pipeline para limitar a consulta.

archived

enum<string>

Define se busca incluir ou retornar apenas leads arquivados: include, only.

Available options:

include,

only

crm_lead_source_id

string<uuid>

ID manual de origem do lead.

lead_sources

string<uuid>[]

Lista de IDs de fontes de marketing (separados por virgula).

campaign_id

string<uuid>

ID da campanha Wegly.

ad_set_id

string<uuid>

ID do conjunto de anuncios.

content_id

string<uuid>

ID do conteudo exibido.

displayed_on_id

string<uuid>

ID do local exibido.

conversion_tool_id

string<uuid>

ID da ferramenta de conversao.

creative_id

string<uuid>

ID da criacao utilizada na campanha.

responsible_id

string<uuid>

ID do responsavel do lead.

created_from

string<date-time>

Data inicial de criacao no formato ISO 8601.

created_to

string<date-time>

Data final de criacao no formato ISO 8601.

last_activity_from

string<date-time>

Data inicial da ultima atividade.

last_activity_to

string<date-time>

Data final da ultima atividade.

won_from

string<date-time>

Data inicial para leads ganhos.

won_to

string<date-time>

Data final para leads ganhos.

lost_from

string<date-time>

Data inicial para leads perdidos.

lost_to

string<date-time>

Data final para leads perdidos.

order_by

enum<string>

Campo de ordenacao: name, created_at, last_activity_at ou quality_rating.

Available options:

name,

created_at,

last_activity_at,

quality_rating

order_direction

enum<string>

Direcao da ordenacao: asc ou desc.

Available options:

asc,

desc

won

enum<string>

Regra de resultado Ganho: include inclui abertos+ganhos, only apenas ganhos.

Available options:

include,

only

lost

enum<string>

Regra de resultado Perdido: include inclui abertos+perdidos, only apenas perdidos.

Available options:

include,

only

only_new

boolean

true limita aos leads que nunca foram visualizados.

without_lead_source

boolean

true limita aos leads sem origem de marketing associada.

all_statuses

boolean

true ignora filtros de status, retornando ganhos, perdidos e arquivados.

Response

Lista paginada de leads.

total

integer

required

Total de leads encontrados.

records

object[]

required

Show child attributes

records.id

string

required

records.code

integer

required

records.title

string

required

records.status

integer

required

1=Aberto, 2=Ganho, 3=Perdido.

records.stage

object

required

Show child attributes

records.stage.id

string

records.stage.name

string

records.stage.pipeline

object

Show child attributes

records.stage.pipeline.id

string

records.stage.pipeline.name

string

records.created_at

string<date-time>

required

records.updated_at

string<date-time>

required

records.created_by_user

object

Show child attributes

records.created_by_user.id

string

required

records.created_by_user.name

string

required

records.created_by_user.avatar

string<uri> | null

records.responsible

object

Show child attributes

records.responsible.id

string

required

records.responsible.name

string

required

records.responsible.avatar

string<uri> | null

records.person

object

Show child attributes

records.person.id

string

records.person.name

string

records.lead_source

object

Show child attributes

records.lead_source.id

string

records.lead_source.name

string

records.lead_source.logo

string<uri> | null

records.quality_rating

integer | null

Required range: 1 <= x <= 5

records.quality_reason

string | null

records.visibility

integer

records.value

number | null

records.tags

object[]

Show child attributes

records.tags.name

string

records.tags.color

string | null

records.pending_tasks_status

enum<string>

Available options:

NONE,

TODAY,

FUTURE,

OVERDUE

records.crm_task

object[]

Show child attributes

records.crm_task.id

string

records.crm_task.title

string

records.crm_task.description

string | null

records.crm_task.priority

integer

records.crm_task.start_date

string<date-time> | null

records.crm_task.crm_task_type

object

Show child attributes

records.crm_task.crm_task_type.id

string

records.crm_task.crm_task_type.name

string

records.crm_task.crm_task_type.icon

string | null

records.negotiation_mode

string | null

records.archived_at

string<date-time> | null

records.won_date

string<date-time> | null

records.lost_date

string<date-time> | null

records.last_activity_at

string<date-time> | null

records.views_count

integer

Cria um lead a partir de uma integracao externa

⌘I

API Reference

Authorizations

Query Parameters

Response