v1

latestOpenAPI 3.0.02026-07-26626596.3 KB

Pipelines

Buscar pipeline por ID

get/api/v1/pipelines/{id}

Path parameters

idstring required

Response

idstring

ID da pipeline.

createdAtstring date-time

Data de criação da pipeline.

updatedAtstring date-time

Data da última atualização da pipeline.

deletedAtstring date-time

Data de exclusão da pipeline (se aplicável).

namestring

Nome da pipeline.

descriptionstring

Descrição da pipeline.

groupstring

Grupo da pipeline.

stagesCountnumber

Número de etapas na pipeline.

Example response

{
  "id": "9c315181-85f2-4772-bd46-8b261599e382",
  "createdAt": "2025-09-09T16:25:16.727Z",
  "updatedAt": "2025-09-19T20:39:49.680Z",
  "name": "pipe 1",
  "description": "Pipeline para gerenciamento de vendas online",
  "group": "Clientes recorrentes",
  "stagesCount": 3,
  "permissions": {
    "id": "c5b65a1d-7b84-4b59-b1a0-7fcb1b6a67f0",
    "createdAt": "2025-09-09T16:25:16.727Z",
    "attendant": {
      "userId": "t9kn9mqPakdGG535GQK3hod8wzM2",
      "id": "6807e48c25ece34f9f1ba7dd",
      "name": "Joao Silva",
      "email": "joaosilva@gmail.com",
      "phone": "5547991331190",
      "imageURL": "https://dc-qqqq1111pb.s3.amazonaws.com/profiles/koQGLa8p68fNZiiSmE1tec2LHtc2_2025-05-24T00%3A27%3A23.486Z"
    },
    "pipelineId": "9c315181-85f2-4772-bd46-8b261599e382",
    "showOnlyMine": true
  }
}