Flow Steps

Stages within playbooks

Retrieves flow steps for a playbook

get/playbooks/{playbook_id}/flow_steps

Returns all stages (flow steps) within a playbook.

Flow steps represent the progression stages for contacts (e.g., "New Lead", "Qualified", "Negotiating"). Use flow step IDs when updating a contact's current position in the sales workflow.

Parámetros de ruta

  • playbook_idstringobligatorio
    The ID of the playbook to retrieve flow steps for
    Ejemplo: 64a1b2c3d4e5f678901234ab

Respuestas

  • 200flow steps found
  • 401unauthorized
  • 404playbook not found
Petición
curl -X GET 'https://api.vixiees.com/api/v1/playbooks/64a1b2c3d4e5f678901234ab/flow_steps' \
  -H 'X-Api-Key: YOUR_API_KEY'
Respuesta de ejemplo · 200
{
  "results": [
    {
      "_id": "string",
      "name": "string",
      "order": 0,
      "flow_type": "string",
      "playbook_id": "string",
      "created_at": "2024-01-01T00:00:00Z",
      "updated_at": "2024-01-01T00:00:00Z"
    }
  ]
}