Process Templates

Process templates are the blueprints that define the structure of a process, including its sections, tasks, and form fields.

List Templates


GET /api/v1/process-templates

Returns a paginated list of all process templates belonging to your team.

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	20	Number of results (1-100)
`cursor`	string	—	Cursor from previous response for pagination

Example Request


curl -H "Authorization: Bearer nxs_live_your_key" \
  "https://getnextstep.io/api/v1/process-templates?limit=5"

Example Response


{
  "data": [
    {
      "id": "CcIJXVzRuiP5HvI26FTE",
      "title": "Employee Onboarding",
      "description": "Standard onboarding process for new hires",
      "cover_image": null,
      "icon": null,
      "icon_type": null,
      "visibility": "team",
      "is_published": true,
      "version": 3,
      "sections": [
        {
          "id": "sec_abc",
          "title": "First Week",
          "description": null,
          "order": 0,
          "color": "#EC4899"
        }
      ],
      "created_at": "2026-01-15T10:00:00.000Z",
      "updated_at": "2026-03-20T14:30:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "CcIJXVzRuiP5HvI26FTE",
    "has_more": true
  }
}

Get a Template


GET /api/v1/process-templates/:id

Returns a single process template by ID, including its sections.

Example Request


curl -H "Authorization: Bearer nxs_live_your_key" \
  "https://getnextstep.io/api/v1/process-templates/CcIJXVzRuiP5HvI26FTE"

Example Response


{
  "data": {
    "id": "CcIJXVzRuiP5HvI26FTE",
    "title": "Employee Onboarding",
    "description": "Standard onboarding process for new hires",
    "is_published": true,
    "version": 3,
    "sections": [
      { "id": "sec_abc", "title": "First Week", "order": 0, "color": "#EC4899" },
      { "id": "sec_def", "title": "First Month", "order": 1, "color": null }
    ],
    "created_at": "2026-01-15T10:00:00.000Z",
    "updated_at": "2026-03-20T14:30:00.000Z"
  }
}

List Template Tasks


GET /api/v1/process-templates/:id/tasks

Returns all tasks defined in a template, ordered by their position. Each task includes its custom elements (form fields).

Query Parameters

Parameter	Type	Default	Description
`limit`	integer	20	Number of results (1-100)
`cursor`	string	—	Cursor for pagination

Example Request


curl -H "Authorization: Bearer nxs_live_your_key" \
  "https://getnextstep.io/api/v1/process-templates/CcIJXVzRuiP5HvI26FTE/tasks"

Example Response


{
  "data": [
    {
      "id": "Y9Rxzi3uDOvGAYojkHti",
      "title": "Review employee details",
      "completed": false,
      "order": 0,
      "section_id": "sec_abc",
      "assignee": null,
      "is_essential": false,
      "type": "task",
      "due_date": null,
      "webhook_enabled": false,
      "custom_elements": [
        {
          "id": "elem_001",
          "type": "shortText",
          "label": "Employee Name",
          "value": null,
          "required": true,
          "display_only": false
        },
        {
          "id": "elem_002",
          "type": "email",
          "label": "Employee Email",
          "value": null,
          "required": true,
          "display_only": false
        },
        {
          "id": "elem_003",
          "type": "text",
          "label": "Instructions",
          "value": "<p>Fill in the employee details above.</p>",
          "required": false,
          "display_only": true
        }
      ],
      "created_at": "2026-01-15T10:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "Y9Rxzi3uDOvGAYojkHti",
    "has_more": true
  }
}

Custom Element Types

Type	`display_only`	Description
`shortText`	false	Single-line text input
`longText`	false	Multi-line text input
`number`	false	Numeric input
`email`	false	Email address input
`website`	false	URL input
`date`	false	Date picker
`checkbox`	false	Boolean checkbox
`dropdown`	false	Single-select dropdown (see `options` array)
`multichoice`	false	Multi-select checkboxes (see `options` array)
`text`	true	Rich text / HTML display block (read-only)
`image`	true	Embedded image (read-only)
`video`	true	Embedded video (read-only)
`file`	true	File attachment (read-only, see `file_url`)
`lineBreak`	true	Visual separator (read-only)

Elements with display_only: true are informational — they show instructions or media to the user but don’t accept input.