RDrdstation
crm-v1-deals

Listar negociações

Listar negociações

get/deals

Request

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

Query parameters

pagestring

Número atual da página

limitstring

Limite de negociações que serão listadas. Valor padrão é 20. Valor máximo é 200

orderstring

Ordenação. Valor padrão é "created_at"

directionstring

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

namestring

Nome da negociação. Para buscas com nome exato, usar o parâmetro exact_name=true

winstring

Negociações ganhas. O valor true (retorna as negociações "ganhas"), false (retorna as negociações "perdidas") e null (retorna as negociações "em aberto")

user_idstring

ID do usuário relacionado à negociação

closed_atstring

Ao informar true (retorna as negociações "ganhas" ou "perdidas"). Ao informar false (retorna as negociações "em aberto" OU "pausadas")

closed_at_periodstring

Data de fechamento da negociação: se true deve ser informado start_date e end_date

created_at_periodstring

Data de criação da negociação: se true, deve ser informado start_date e end_date

prediction_date_periodstring

Data de previsão de fechamento da negociação: se true, deve ser informado start_date e end_date

start_datestring

Primeiro dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_period. Ex.: "start_date": "2020-12-14T15:00:00"

end_datestring

Último dia/hora em que deve ser aplicado o filtro para o parâmetro closed_at_period ou created_at_period. Ex.: "end_date": "2020-12-14T15:00:00"

campaign_idstring

ID da campanha

deal_stage_idstring

ID da etapa do funil de vendas

deal_lost_reason_idstring

ID do motivo de perda

deal_pipeline_idstring

ID do funil de vendas

organizationstring

ID da empresa

holdstring

Estado da negociação pausada. Se marcado como true (retorna todas negociações "pausadas"). Para outros casos, não deve-se utilizar esse parâmetro

product_presencestring

Negociações que contenham produtos/serviços relacionados. Se false (nenhum produto relacionado), true (um ou mais produtos relacionados) ou uma lista de IDs de produto. A lista de IDs deve ser informada com os valores separados por vírgula. Ex.: 5esdsds, d767dsdssd, c6e40fd2f000972a083

next_pagestring

O parâmetro next_page serve para consultar a próxima página de resultados da busca corrente. Ele é obtido através da primeira consulta feita por esta API, porém todos os demais resultados apresentam este campo que se utilizado na requisição, navegam para sua próxima página.

Response

Success

has_moreboolean
next_pagestring
totalnumber

Example response

{
  "deals": [
    {
      "_id": "ID",
      "amount_total": 399.83,
      "amount_unique": 399.83,
      "contacts": [
        {
          "birthday": {
            "_id": "ID",
            "day": 11,
            "month": 9,
            "year": 1979
          },
          "emails": [
            {
              "email": "email1@empresa.com"
            }
          ],
          "name": "NAME",
          "phones": [
            {
              "phone": "3165585457",
              "type": "cellphone"
            }
          ],
          "skype": "EMAIL",
          "title": "Gerente"
        }
      ],
      "created_at": "2023-02-16T10:29:36.600-03:00",
      "deal_products": [
        {
          "_id": "ID",
          "amount": 1,
          "amount_decimal": 1.1,
          "base_price": 199.91,
          "created_at": "2023-02-16T10:29:36.778-03:00",
          "description": "Description Product 1",
          "discount_type": "value",
          "id": "ID",
          "name": "Product 01",
          "price": 199.91,
          "product_id": "ID",
          "recurrence": "spare",
          "total": 199.91,
          "updated_at": "2023-02-16T10:29:36.778-03:00"
        }
      ],
      "deal_stage": {
        "_id": "ID",
        "created_at": "2022-04-26T16:17:58.214-03:00",
        "id": "ID",
        "name": "Sem contato",
        "nickname": "SC",
        "updated_at": "2022-04-26T16:17:58.214-03:00"
      },
      "id": "ID",
      "markup": "future",
      "markup_created": "8 days",
      "name": "nome da oportunidade 1",
      "rating": 1,
      "updated_at": "2023-02-16T10:30:05.171-03:00",
      "user": {
        "_id": "ID",
        "email": "EMAIL",
        "id": "ID",
        "name": "NAME",
        "nickname": "RP"
      },
      "user_changed": true
    }
  ],
  "next_page": "i-1726778672521,s-66ec8d30f2f11000139ab5ff",
  "total": 1
}

Changes

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