v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar atividades

Retorna a listagem de atividades cadastradas na conta.

get/activities

Query parameters

showinteger

Número de itens exibidos na página de resultado. Máximo de 200 registros por página.

cursorstring

Hash da próxima página.

sortstring

Escolha uma coluna para ordenar os resultados

deal_idinteger

ID da oportunidade vinculada a atividade

owner_idinteger

ID do usuário responsável pela atividade

requester_idinteger

ID do usuário que criou a atividade

titlestring

Título da atividade

activity_type_idinteger

ID do tipo de atividade

statusinteger

Status da atividade. Opções: 0= Aberta | 2= Concluida | 4= No show

start_at_startstring date-time

Data e hora de início da atividade. Considere que este parâmetro é o valor inicial do filtro por período de datas.

start_at_endstring date-time

Data e hora de início da atividade. Considere que este parâmetro é o valor final do filtro por período de datas.

delivery_date_startstring date-time

Data e hora de conclusão da atividade. Considere que este parâmetro é o valor inicial do filtro por período de datas.

delivery_date_endstring date-time

Data e hora de conclusão da atividade. Considere que este parâmetro é o valor final do filtro por período de datas.

end_at_startstring date-time

Data e hora de fim da atividade. Considere que este parâmetro é o valor inicial do filtro por período de datas.

end_at_endstring date-time

Data e hora de fim da atividade. Considere que este parâmetro é o valor final do filtro por período de datas.

created_at_startstring date-time

Data e hora de criação da atividade. Considere que este parâmetro é o valor inicial do filtro por período de datas.

created_at_endstring date-time

Data e hora de criação da atividade. Considere que este parâmetro é o valor final do filtro por período de datas.

updated_at_startstring date-time

Data e hora em que a atividade foi atualizada. Considere que este parâmetro é o valor inicial do filtro por período de datas.

updated_at_endstring date-time

Data e hora em que a atividade foi atualizada. Considere que este parâmetro é o valor final do filtro por período de datas.

Response

200

sucessboolean

messagestring

Example response

{
  "sucess": true,
  "message": "OK",
  "data": [
    {
      "id": 123,
      "google_calendar_id": 1,
      "outlook_calendar_id": 1,
      "project_id": 1,
      "appointment_id": 1,
      "activity_type_id": 123,
      "activity_type": 123,
      "owner_id": 123,
      "account_id": 123,
      "deal_id": 123,
      "working": true,
      "time_utilized": 1,
      "time_estimated": 1,
      "duration": 60,
      "priority": 3,
      "type": 5,
      "requester_id": 123,
      "title": "Reunião com cliente",
      "description": "Encontrar cliente x para discutir sobre a proposta",
      "order": 1,
      "delivery_date": "2021-11-11 08:59:00",
      "start_at": "2021-08-10 16:00:00",
      "end_at": "2021-08-10 17:00:00",
      "internal_date": "2021-11-11 09:08:55",
      "created_at": "2021-08-09 11:27:07",
      "updated_at": "2021-08-09 11:27:07"
    }
  ],
  "meta": {
    "cursor": {
      "next": "eyJpZCI6........eHRJdGVtcyI6dHJ1ZX0"
    }
  }
}