> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Nooks List Sequence States: Inputs, Cost & CLI Example
> List sequence states. Nooks Nooks List Sequence States docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=nooks_list_sequence_states:{}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| ----------------- | -------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------- |
| `payload.page` | `object` | No | | Number of items per page (max 100) |
| `payload.filter` | `object` | No | | Filter by state (comma-separated). Valid values: active, paused, finished |
| `payload.include` | `array` | No | | Comma-separated relations to expand inline. Valid values: `sequence`, `prospect`, `creator`, `sequenceStep`. Max 3. |
Show raw input schema
### Input JSON Schema
````json theme={null}
{
"type": "object",
"description": "Returns a paginated list of sequence states (enrollments). Supports filtering by sequence, prospect, account, and state. Example: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceStates?page[size]=50' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by sequence: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceStates?filter[sequence][id]=550e8400-e29b-41d4-a716-446655440000' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by account (joins through prospect): ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceStates?filter[account][id]=990e8400-e29b-41d4-a716-446655440099' \\ -H \"Authorization: Bearer nooks-api-...\" ``` Filter by state: ```bash curl -X GET 'https://partner-api.nooks.in/v1/sequenceStates?filter[state]=active,paused' \\ -H \"Authorization: Bearer nooks-api-...\" ```",
"properties": {
"page": {
"type": "object",
"description": "Number of items per page (max 100)",
"properties": {
"size": {
"type": "integer",
"description": "Number of items per page (max 100)",
"default": 50,
"minimum": 1,
"maximum": 100
},
"after": {
"type": "string",
"description": "Cursor for fetching the next page. Opaque token returned by the API in `links.next`; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return `400 Bad Request`."
},
"before": {
"type": "string",
"description": "Cursor for fetching the previous page. Opaque token returned by the API in `links.prev`; callers should treat it as opaque and only pass values they received from a previous response. Malformed cursors return `400 Bad Request`."
}
},
"required": [],
"additionalProperties": false
},
"filter": {
"type": "object",
"description": "Filter by state (comma-separated). Valid values: active, paused, finished",
"properties": {
"state": {
"type": "array",
"description": "Filter by state (comma-separated). Valid values: active, paused, finished",
"items": {
"type": "string",
"enum": [
"active",
"paused",
"finished"
]
}
},
"updatedAt": {
"type": "object",
"description": "Filter by minimum updatedAt (ISO 8601 datetime)",
"properties": {
"gte": {
"type": "string",
"description": "Filter by minimum updatedAt (ISO 8601 datetime)",
"format": "date-time"
},
"lt": {
"type": "string",
"description": "Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)",
"format": "date-time"
}
},
"required": [],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
"include": {
"type": "array",
"description": "Comma-separated relations to expand inline. Valid values: `sequence`, `prospect`, `creator`, `sequenceStep`. Max 3.",
"maxItems": 3,
"items": {
"type": "string",
"enum": [
"sequence",
"prospect",
"creator",
"sequenceStep"
]
}
}
},
"required": [],
"additionalProperties": false
}
````
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | ---------------------------------------------- |
| `result.data` | `object` | Yes | | Provider response payload. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Provider response payload.",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"description": "A prospect's enrollment in a sequence",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the sequence state",
"format": "uuid"
},
"state": {
"type": "string",
"description": "Current state of the enrollment: - `active`: Prospect is actively progressing through the sequence - `paused`: Enrollment is temporarily paused - `finished`: Enrollment has completed or been stopped",
"enum": [
"active",
"paused",
"finished"
]
},
"sequence": {
"type": "object",
"description": "A reference to a related resource",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the referenced resource"
},
"_href": {
"type": "string",
"description": "API path to the referenced resource"
}
},
"required": [
"id",
"_href"
],
"additionalProperties": false
},
"prospect": {
"type": "object",
"description": "A reference to a related resource",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the referenced resource"
},
"_href": {
"type": "string",
"description": "API path to the referenced resource"
}
},
"required": [
"id",
"_href"
],
"additionalProperties": false
},
"account": {
"type": [
"object",
"null"
],
"description": "A reference to a related resource",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the referenced resource"
},
"_href": {
"type": "string",
"description": "API path to the referenced resource"
}
},
"required": [
"id",
"_href"
],
"additionalProperties": false
},
"creator": {
"type": "object",
"description": "A reference to a related resource",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the referenced resource"
},
"_href": {
"type": "string",
"description": "API path to the referenced resource"
}
},
"required": [
"id",
"_href"
],
"additionalProperties": false
},
"owner": {
"type": "object",
"description": "A reference to a related resource",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the referenced resource"
},
"_href": {
"type": "string",
"description": "API path to the referenced resource"
}
},
"required": [
"id",
"_href"
],
"additionalProperties": false
},
"sequenceStep": {
"type": [
"object",
"null"
],
"description": "A reference to a related resource",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the referenced resource"
},
"_href": {
"type": "string",
"description": "API path to the referenced resource"
}
},
"required": [
"id",
"_href"
],
"additionalProperties": false
},
"createdAt": {
"type": "string",
"description": "When the enrollment was created",
"format": "date-time"
},
"updatedAt": {
"type": "string",
"description": "When the enrollment was last updated",
"format": "date-time"
}
},
"required": [
"id",
"state",
"sequence",
"prospect",
"creator",
"owner",
"sequenceStep",
"createdAt",
"updatedAt"
],
"additionalProperties": false
}
},
"links": {
"type": "object",
"description": "Pagination links for navigating through results. Links are returned as relative references (path + query) that should be resolved against the base URL of the request.",
"properties": {
"first": {
"type": "string",
"description": "URL for the first page",
"format": "uri-reference"
},
"prev": {
"type": [
"string",
"null"
],
"description": "URL for the previous page (null if on first page)",
"format": "uri-reference"
},
"next": {
"type": [
"string",
"null"
],
"description": "URL for the next page (null if on last page)",
"format": "uri-reference"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute nooks_list_sequence_states --payload '{}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.