---
agentTools:
  projectIndex: https://developers.pipe.run/llms.txt
---

# Listar atividades

Retorna a listagem de atividades cadastradas na conta.

## ⚠️  Atenção!

* É importante que veja as possibilidades de busca de relacionamentos e também a(s) lista(s) de parâmetros da entidade.
* Lembrando que os filtros de data funcionam com intervalos. [Aqui](https://vendas.developers.pipe.run/docs/filtros-em-consultas) explicamos em detalhes o filtro de datas.

### Listagem de atributos possíveis de realizar um relacionamento com o parâmetro `with`

Com este atributo é possível buscar entidades relacionadas ao registro que buscamos.

> deal\
> owner\
> requester\
> activityType\
> persons\
> companies\
> pipeline\
> stage

### Lista de status da atividade

| Valor | Status    |
| ----- | --------- |
| 0     | Aberta    |
| 2     | Concluída |
| 4     | No Show   |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "application/json",
    "version": "1.1-CRM"
  },
  "servers": [
    {
      "url": "https://api.pipe.run/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "token",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/activities": {
      "get": {
        "summary": "Listar atividades",
        "description": "Retorna a listagem de atividades cadastradas na conta.",
        "operationId": "listar-atividades",
        "parameters": [
          {
            "name": "show",
            "in": "query",
            "description": "Número de itens exibidos na página de resultado. Máximo de 200 registros por página.",
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 15
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "Hash da próxima página.",
            "schema": {
              "type": "string",
              "default": "\"\""
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Escolha uma coluna para ordenar os resultados",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "deal_id",
            "in": "query",
            "description": "ID da oportunidade vinculada a atividade",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "owner_id",
            "in": "query",
            "description": "ID do usuário responsável pela atividade",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "requester_id",
            "in": "query",
            "description": "ID do usuário que criou a atividade",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "title",
            "in": "query",
            "description": "Título da atividade",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "activity_type_id",
            "in": "query",
            "description": "ID do tipo de atividade",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "status",
            "in": "query",
            "description": "Status da atividade. Opções: `0`= Aberta | `2`= Concluida | `4`= No show",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "start_at_start",
            "in": "query",
            "description": "Data e hora de início da atividade. Considere que este parâmetro é o valor inicial do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "start_at_end",
            "in": "query",
            "description": "Data e hora de início da atividade. Considere que este parâmetro é o valor final do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "delivery_date_start",
            "in": "query",
            "description": "Data e hora de conclusão da atividade. Considere que este parâmetro é o valor inicial do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "delivery_date_end",
            "in": "query",
            "description": "Data e hora de conclusão da atividade. Considere que este parâmetro é o valor final do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "end_at_start",
            "in": "query",
            "description": "Data e hora de fim da atividade. Considere que este parâmetro é o valor inicial do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "end_at_end",
            "in": "query",
            "description": "Data e hora de fim da atividade. Considere que este parâmetro é o valor final do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "created_at_start",
            "in": "query",
            "description": "Data e hora de criação da atividade. Considere que este parâmetro é o valor inicial do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "created_at_end",
            "in": "query",
            "description": "Data e hora de criação da atividade. Considere que este parâmetro é o valor final do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "updated_at_start",
            "in": "query",
            "description": "Data e hora em que a atividade foi atualizada. Considere que este parâmetro é o valor inicial do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          },
          {
            "name": "updated_at_end",
            "in": "query",
            "description": "Data e hora em que a atividade foi atualizada. Considere que este parâmetro é o valor final do filtro por período de datas.",
            "schema": {
              "type": "string",
              "format": "date-time"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"sucess\": true,\n  \"message\": \"OK\",\n  \"data\": [\n    {\n      \"id\": 123,\n      \"status\": 0,\n      \"google_calendar_id\": 1,\n      \"outlook_calendar_id\": 1,\n      \"project_id\": 1,\n      \"appointment_id\": 1,\n      \"activity_type_id\": 123,\n      \"activity_type\": 123,\n      \"owner_id\": 123,\n      \"account_id\": 123,\n      \"deal_id\": 123,\n      \"working\": true,\n      \"time_utilized\": 1,\n      \"time_estimated\": 1,\n      \"duration\": 60,\n      \"priority\": 3,\n      \"type\": 5,\n      \"requester_id\": 123,\n      \"title\": \"Reunião com cliente\",\n      \"description\": \"Encontrar cliente x para discutir sobre a proposta\",\n      \"hash\": \"\",\n      \"comment\": \"\",\n      \"appearin_link\": \"\",\n      \"order\": 1,\n      \"lat\": 0,\n      \"lng\": 0,\n      \"delivery_date\": \"2021-11-11 08:59:00\",\n      \"start_at\": \"2021-08-10 16:00:00\",\n      \"end_at\": \"2021-08-10 17:00:00\",\n      \"internal_date\": \"2021-11-11 09:08:55\",\n      \"created_at\": \"2021-08-09 11:27:07\",\n      \"updated_at\": \"2021-08-09 11:27:07\"\n    }\n  ],\n  \"meta\": {\n   \"cursor\": {\n      \"current\": null,\n      \"prev\": null,\n      \"next\": \"eyJpZCI6........eHRJdGVtcyI6dHJ1ZX0\",\n      \"count\": null\n    }\n  }\n}\n"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "sucess": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "message": {
                      "type": "string",
                      "example": "OK"
                    },
                    "data": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "integer",
                            "example": 123,
                            "default": 0
                          },
                          "status": {
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          },
                          "google_calendar_id": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "outlook_calendar_id": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "project_id": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "appointment_id": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "activity_type_id": {
                            "type": "integer",
                            "example": 123,
                            "default": 0
                          },
                          "activity_type": {
                            "type": "integer",
                            "example": 123,
                            "default": 0
                          },
                          "owner_id": {
                            "type": "integer",
                            "example": 123,
                            "default": 0
                          },
                          "account_id": {
                            "type": "integer",
                            "example": 123,
                            "default": 0
                          },
                          "deal_id": {
                            "type": "integer",
                            "example": 123,
                            "default": 0
                          },
                          "working": {
                            "type": "boolean",
                            "example": true,
                            "default": true
                          },
                          "time_utilized": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "time_estimated": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "duration": {
                            "type": "integer",
                            "example": 60,
                            "default": 0
                          },
                          "priority": {
                            "type": "integer",
                            "example": 3,
                            "default": 0
                          },
                          "type": {
                            "type": "integer",
                            "example": 5,
                            "default": 0
                          },
                          "requester_id": {
                            "type": "integer",
                            "example": 123,
                            "default": 0
                          },
                          "title": {
                            "type": "string",
                            "example": "Reunião com cliente"
                          },
                          "description": {
                            "type": "string",
                            "example": "Encontrar cliente x para discutir sobre a proposta"
                          },
                          "hash": {
                            "type": "string",
                            "example": ""
                          },
                          "comment": {
                            "type": "string",
                            "example": ""
                          },
                          "appearin_link": {
                            "type": "string",
                            "example": ""
                          },
                          "order": {
                            "type": "integer",
                            "example": 1,
                            "default": 0
                          },
                          "lat": {
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          },
                          "lng": {
                            "type": "integer",
                            "example": 0,
                            "default": 0
                          },
                          "delivery_date": {
                            "type": "string",
                            "example": "2021-11-11 08:59:00"
                          },
                          "start_at": {
                            "type": "string",
                            "example": "2021-08-10 16:00:00"
                          },
                          "end_at": {
                            "type": "string",
                            "example": "2021-08-10 17:00:00"
                          },
                          "internal_date": {
                            "type": "string",
                            "example": "2021-11-11 09:08:55"
                          },
                          "created_at": {
                            "type": "string",
                            "example": "2021-08-09 11:27:07"
                          },
                          "updated_at": {
                            "type": "string",
                            "example": "2021-08-09 11:27:07"
                          }
                        }
                      }
                    },
                    "meta": {
                      "type": "object",
                      "properties": {
                        "cursor": {
                          "type": "object",
                          "properties": {
                            "current": {},
                            "prev": {},
                            "next": {
                              "type": "string",
                              "example": "eyJpZCI6........eHRJdGVtcyI6dHJ1ZX0"
                            },
                            "count": {}
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": false,\n  \"message\": \"Not Found\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "message": {
                      "type": "string",
                      "example": "Not Found"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "686d5ab389846000619e863f:686d5ab389846000619e8660"
}
```