Nooks
App · 20 actions
Read prospects, accounts, sequences, calls and emails, manage standalone tasks, and watch records for changes.
Actions
| Action | What it does |
|---|---|
| Create a task | Create a one-off task that is not part of a sequence. |
| Delete a task | Permanently delete a task. |
| Get account by ID | Get one account by its ID. |
| Get call by ID (SEP view, with sequence and step) | Get one call made in a Nooks sequence by its ID, with its sequence and step. |
| Get email by ID | Get one email by its ID. |
| Get prospect by ID | Get one prospect by its ID, from the CRM or from Nooks itself. |
| Get sequence by ID | Get one sequence by its ID. |
| Get sequence state by ID | Get one sequence enrollment by its ID. |
| Get task by ID | Get one task by its ID. |
| Get the authenticated principal | Get the workspace and user this connection belongs to. |
| Get user by ID | Get one user in the workspace by their ID. |
| List accounts | List the accounts (companies) in the workspace, one page at a time, with optional filters. |
| List calls (SEP view, with sequence and step) | List calls made in Nooks sequences, one page at a time, each with the sequence and step it belongs to. |
| List emails | List emails, one page at a time. |
| List prospects | List the workspace's prospects, one page at a time, from its CRM (Salesforce or HubSpot) and from Nooks itself; the source field says which. |
| List sequence states | List sequence enrollments, one page at a time. |
| List sequences | List sequences, one page at a time. |
| List tasks | List tasks, one page at a time. |
| List users | List the users in the workspace who have a seat, one page at a time. |
| Update a task | Update one or more fields of a task. |
Create a task
Create a one-off task that is not part of a sequence. It is checked and synced to your CRM automatically.
Inputs
- Task type
task_typetextRequired - Type of task action. manual_inmail (a Sales Navigator InMail the rep writes and sends) returns 422 for workspaces without Sales Navigator InMail.One of:
call,manual_email,manual_email_reply,basic_task,linkedin_connection_request,manual_linkedin_connection_request,manual_linkedin_message,manual_inmail,manual_sms. - Due at
due_atdate and timeRequired - When the task is due (ISO 8601 with timezone offset)
- Owner
owner_idtextRequired - ID of the user who owns this task (Firebase UID)
- Prospect
prospect_idtextRequired - ID of the prospect this task is for
- Note
notetext - Optional note or instructions for the task
- Priority
prioritytext - Priority level of the taskOne of:
low,normal,high,urgent.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"action": "call",
"completed": false,
"createdAt": "2026-11-13T12:00:00Z",
"dueAt": "2026-11-13T12:00:00Z",
"email": {
"_href": "example",
"id": "example"
},
"id": "00000000-0000-4000-8000-000000000001",
"note": "example",
"owner": {
"_href": "example",
"id": "example"
},
"priority": "low",
"prospect": {
"_href": "example",
"id": "example"
},
"sequence": {
"_href": "example",
"id": "example"
},
"sequenceState": {
"_href": "example",
"id": "example"
},
"sequenceStep": {
"_href": "example",
"id": "example"
},
"status": "example",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}Delete a task
Permanently delete a task. If the task is part of an active sequence enrollment, the enrollment first moves on to the next step, or finishes if this was the last step.
Inputs
- Task
task_idtextRequired - Unique identifier for the task to delete
Outputs
Response.
datanull- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": null,
"has_more": false,
"next_cursor": null
}Get account by ID
Get one account by its ID.
Inputs
- Account
account_idtextRequired - Unique identifier for the account
- Include crmcustom fields
include_crmcustom_fieldstext - When true, each returned record's crmCustomFields carries the record's CRM custom fields as a single JSON object keyed by the CRM field id/key (e.g. {"hs_lead_status": "OPEN"}). Values are typed per the CRM field's data type (string, number, boolean, string array, or ISO-8601 date string, so a date field's value is not distinguishable from a string field's on the wire). A registered field with no stored value is null. Only fields with a currently-registered CRM attribute definition in the workspace are returned. The field itself is always present in responses; without this opt-in (the default) it is an empty object {} and no custom-field data is fetched.One of:
true,false.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"createdAt": "2026-11-13T12:00:00Z",
"crmCustomFields": {},
"description": "example",
"domain": "example",
"id": "00000000-0000-4000-8000-000000000001",
"linkedInUrl": "example",
"name": "example",
"numEmployees": 0,
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}Get call by ID (SEP view, with sequence and step)
Get one call made in a Nooks sequence by its ID, with its sequence and step.
Inputs
- Call
call_idtextRequired - Unique identifier for the call
- Include
includelist - Comma-separated relations to expand inline. Valid values: prospect, sequence, sequenceStep, callDisposition, owner. Max 6.One or more of:
prospect,sequence,sequenceStep,callDisposition,owner.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"callDisposition": {
"_href": "example",
"id": "example"
},
"createdAt": "2026-11-13T12:00:00Z",
"direction": "example",
"duration": 0,
"from": "example",
"id": "00000000-0000-4000-8000-000000000001",
"owner": {
"_href": "example",
"id": "example"
},
"prospect": {
"_href": "example",
"id": "example"
},
"recordingUrl": "example",
"sequence": {
"_href": "example",
"id": "example"
},
"sequenceStep": {
"_href": "example",
"id": "example"
},
"source": "example",
"time": "2026-11-13T12:00:00Z",
"to": "example",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}Get email by ID
Get one email by its ID.
Inputs
- Email
email_idtextRequired - Unique identifier for the email
- Include
includelist - Comma-separated relations to expand inline. Valid values: prospect, task, sequence, sequenceStep. Max 6.One or more of:
prospect,task,sequence,sequenceStep.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"bodyHtml": "example",
"bodyText": "example",
"bouncedAt": "2026-11-13T12:00:00Z",
"clickCount": 0,
"clickedAt": "2026-11-13T12:00:00Z",
"createdAt": "2026-11-13T12:00:00Z",
"date": "2026-11-13T12:00:00Z",
"deliveredAt": "2026-11-13T12:00:00Z",
"from": "example",
"id": "00000000-0000-4000-8000-000000000001",
"openCount": 0,
"openedAt": "2026-11-13T12:00:00Z",
"prospect": {
"_href": "example",
"id": "example"
},
"recipients": [],
"repliedAt": "2026-11-13T12:00:00Z",
"sequence": {
"_href": "example",
"id": "example"
},
"sequenceStep": {
"_href": "example",
"id": "example"
},
"status": "example",
"subject": "example",
"task": {
"_href": "example",
"id": "example"
},
"to": "example",
"type": "example",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}Get prospect by ID
Get one prospect by its ID, from the CRM or from Nooks itself. Prospects from other sequencing tools are not found.
Inputs
- Prospect
prospect_idtextRequired - Unique identifier for the prospect
- Include
includelist - Comma-separated relations to expand inline. Valid values: sequenceStates, phoneNumbers. Max 6. phoneNumbers adds the prospect's dialable phone numbers (the PhoneNumber schema). During the beta it needs the Enrichment API enabled for the workspace; otherwise the request answers 403 INSUFFICIENT_PERMISSION. account is not yet includable. Fetch it via the _href on the account reference instead.One or more of:
sequenceStates,phoneNumbers. - Include crmcustom fields
include_crmcustom_fieldstext - When true, each returned record's crmCustomFields carries the record's CRM custom fields as a single JSON object keyed by the CRM field id/key (e.g. {"hs_lead_status": "OPEN"}). Values are typed per the CRM field's data type (string, number, boolean, string array, or ISO-8601 date string, so a date field's value is not distinguishable from a string field's on the wire). A registered field with no stored value is null. Only fields with a currently-registered CRM attribute definition in the workspace are returned. The field itself is always present in responses; without this opt-in (the default) it is an empty object {} and no custom-field data is fetched.One of:
true,false.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"account": {
"_href": "example",
"id": "example"
},
"createdAt": "2026-11-13T12:00:00Z",
"crmCustomFields": {},
"crmId": "example",
"firstName": "example",
"id": "00000000-0000-4000-8000-000000000001",
"lastName": "example",
"linkedInUrl": "example",
"name": "example",
"phoneNumbers": [],
"primaryEmail": "example",
"sequenceStates": [],
"source": "salesforce",
"title": "example",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}Get sequence by ID
Get one sequence by its ID.
Inputs
- Sequence
sequence_idtextRequired - Unique identifier for the sequence
- Include
includelist - Comma-separated relations to expand inline (owner, sequenceSteps). Max 6.One or more of:
owner,sequenceSteps.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"analytics": {
"calls": {
"connected": 0,
"dialed": 0,
"meetings": 0
},
"email": {
"bounced": 0,
"clicked": 0,
"delivered": 0,
"objectionReplies": 0,
"opened": 0,
"positiveReplies": 0,
"referralReplies": 0,
"replied": 0,
"unsubscribed": 0
},
"linkedIn": {
"connectionRequestsAccepted": 0,
"connectionRequestsSent": 0,
"messagesSent": 0,
"repliesReceived": 0
}
},
"createdAt": "2026-11-13T12:00:00Z",
"enabled": false,
"id": "00000000-0000-4000-8000-000000000001",
"name": "example",
"owner": {
"_href": "example",
"id": "example"
},
"parentSequence": {
"_href": "example",
"id": "example"
},
"parentSequenceStep": {
"_href": "example",
"id": "example"
},
"privacy": "private",
"sequenceSteps": [],
"tags": [],
"type": "date",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}Get sequence state by ID
Get one sequence enrollment by its ID.
Inputs
- Enrollment
enrollment_idtextRequired - Unique identifier for the sequence state
- Include
includelist - Comma-separated relations to expand inline. Valid values: sequence, prospect, creator, sequenceStep. Max 6.One or more of:
sequence,prospect,creator,sequenceStep.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"account": {
"_href": "example",
"id": "example"
},
"analytics": {
"email": {
"bounced": 0,
"clicked": 0,
"delivered": 0,
"opened": 0,
"replied": 0,
"unsubscribed": 0
}
},
"createdAt": "2026-11-13T12:00:00Z",
"creator": {
"_href": "example",
"id": "example"
},
"id": "00000000-0000-4000-8000-000000000001",
"owner": {
"_href": "example",
"id": "example"
},
"prospect": {
"_href": "example",
"id": "example"
},
"sequence": {
"_href": "example",
"id": "example"
},
"sequenceStep": {
"_href": "example",
"id": "example"
},
"state": "active",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}Get task by ID
Get one task by its ID.
Inputs
- Task
task_idtextRequired - Unique identifier for the task
- Include
includelist - Comma-separated relations to expand inline. Valid values: owner, prospect, sequence, sequenceState, sequenceStep, email. Max 6. With OAuth, email also requires the emails:read scope (403 without it).One or more of:
owner,prospect,sequence,sequenceState,sequenceStep,email.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"action": "call",
"completed": false,
"createdAt": "2026-11-13T12:00:00Z",
"dueAt": "2026-11-13T12:00:00Z",
"email": {
"_href": "example",
"id": "example"
},
"id": "00000000-0000-4000-8000-000000000001",
"note": "example",
"owner": {
"_href": "example",
"id": "example"
},
"priority": "low",
"prospect": {
"_href": "example",
"id": "example"
},
"sequence": {
"_href": "example",
"id": "example"
},
"sequenceState": {
"_href": "example",
"id": "example"
},
"sequenceStep": {
"_href": "example",
"id": "example"
},
"status": "example",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}Get the authenticated principal
Get the workspace and user this connection belongs to. Useful for checking that the connection still works.
Inputs
None.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"authType": "oauth",
"clientId": "example",
"email": "example",
"name": "example",
"scopes": [],
"userId": "example",
"workspace": {
"products": {
"conversationIntelligence": false,
"dialer": false,
"enrichment": false,
"sequencing": false
}
},
"workspaceId": "example"
},
"has_more": false,
"next_cursor": null
}Get user by ID
Get one user in the workspace by their ID. In a workspace with unlimited access this includes members without a seat.
Inputs
- Member
member_idtextRequired - Unique identifier for the user
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"createdAt": "2026-11-13T12:00:00Z",
"crmId": "example",
"email": "example",
"id": "example",
"name": "example",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}List accounts
List the accounts (companies) in the workspace, one page at a time, with optional filters.
Inputs
- Page size
page_sizenumber - Number of items per page (max 100)From 1 to 100.
- Page after
page_aftertext - 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.
- Page before
page_beforetext - 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.
- Filter id
filter_idtext - Comma-separated list of account UUIDs to fetch
- Filter name
filter_nametext - Filter accounts by exact name match
- Filter domain
filter_domaintext - Filter accounts by exact domain match
- Filter crm id
filter_crm_idtext - Filter accounts by CRM external ID
- Filter updated at gte
filter_updated_at_gtedate and time - Filter by minimum updatedAt (ISO 8601 datetime)
- Filter updated at lt
filter_updated_at_ltdate and time - Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)
- Include crmcustom fields
include_crmcustom_fieldstext - When true, each returned record's crmCustomFields carries the record's CRM custom fields as a single JSON object keyed by the CRM field id/key (e.g. {"hs_lead_status": "OPEN"}). Values are typed per the CRM field's data type (string, number, boolean, string array, or ISO-8601 date string, so a date field's value is not distinguishable from a string field's on the wire). A registered field with no stored value is null. Only fields with a currently-registered CRM attribute definition in the workspace are returned. The field itself is always present in responses; without this opt-in (the default) it is an empty object {} and no custom-field data is fetched.One of:
true,false.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"links": {
"first": "example",
"next": "example",
"prev": "example"
}
},
"has_more": false,
"next_cursor": null
}List calls (SEP view, with sequence and step)
List calls made in Nooks sequences, one page at a time, each with the sequence and step it belongs to. You can filter by ID and by when the call was last updated.
Inputs
- Page size
page_sizenumber - Number of items per page (max 100)From 1 to 100.
- Page after
page_aftertext - 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.
- Page before
page_beforetext - 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.
- Filter id
filter_idtext - Filter by IDs (comma-separated UUIDs). An empty value is treated as "no filter".
- Filter updated at gte
filter_updated_at_gtedate and time - Filter by minimum updatedAt (ISO 8601 datetime)
- Filter updated at lt
filter_updated_at_ltdate and time - Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)
- Filter time gte
filter_time_gtedate and time - Filter calls that occurred at or after this timestamp (ISO 8601). time is the actual call time (distinct from createdAt, which is the ingestion time).
- Filter time lte
filter_time_ltedate and time - Filter calls that occurred at or before this timestamp (ISO 8601).
- Filter created at gte
filter_created_at_gtedate and time - Filter calls ingested at or after this timestamp (ISO 8601).
- Filter created at lte
filter_created_at_ltedate and time - Filter calls ingested at or before this timestamp (ISO 8601).
- Filter prospect id
filter_prospect_idtext - Filter calls to a specific prospect.
- Filter account id
filter_account_idtext - Filter calls associated with a specific account. Matches the account snapshot stored on the call at ingestion time.
- Filter call disposition id
filter_call_disposition_idtext - Filter calls by their recorded disposition.
- Filter owner id
filter_owner_idtext - Filter calls placed by a specific user. Matched via the linked caller's userId (the User who owns the caller record).
- Include
includelist - Comma-separated relations to expand inline. Valid values: prospect, sequence, sequenceStep, callDisposition, owner. Max 6.One or more of:
prospect,sequence,sequenceStep,callDisposition,owner.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"links": {
"first": "example",
"next": "example",
"prev": "example"
}
},
"has_more": false,
"next_cursor": null
}List emails
List emails, one page at a time. You can filter by ID, prospect, task, sequence, account, status and when the email was last updated.
Inputs
- Page size
page_sizenumber - Number of items per page (max 100)From 1 to 100.
- Page after
page_aftertext - 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.
- Page before
page_beforetext - 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.
- Filter id
filter_idtext - Filter by IDs (comma-separated UUIDs). An empty value is treated as "no filter".
- Filter prospect id
filter_prospect_idtext - Filter emails for a specific prospect
- Filter task id
filter_task_idtext - Filter emails by the sequence task they were sent for. Matches Email.sepTaskId (null for emails unrelated to a sequence task).
- Filter account id
filter_account_idtext - Filter emails associated with a specific account. Joins through the email's prospect (Prospect.accountId); rows whose prospect has no account, or rows with no prospect, are excluded.
- Filter sequence id
filter_sequence_idtext - Returns the emails whose sequence.id is this sequence. An email with sequence: null, including one whose task was deleted, never matches. Combine with filter[updatedAt][gte] and filter[updatedAt][lt] to limit the results to a time window.
- Filter status
filter_statuslist - Filter emails by delivery status. Accepts a comma-separated list; rows matching any of the provided statuses are returned. Legacy rows may carry statuses outside this set (e.g. delivered, sent_from_gmail). Filtering is case-sensitive and exact, so those rows will not match sent. draft never matches here: unsent drafts are excluded from this list entirely. Fetch them by id via GET /v1/emails/{id}.One or more of:
draft,in_progress,sent,failed. - Filter updated at gte
filter_updated_at_gtedate and time - Filter by minimum updatedAt (ISO 8601 datetime)
- Filter updated at lt
filter_updated_at_ltdate and time - Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)
- Include
includelist - Comma-separated relations to expand inline. Valid values: prospect, task, sequence, sequenceStep. Max 6.One or more of:
prospect,task,sequence,sequenceStep. - Exclude body
exclude_bodytrue/false - When true, bodyHtml and bodyText are returned as null on every email instead of the full message bodies. Use it when you only need metadata (status, timestamps, sender, sequence), e.g. counting sends per sequence or mailbox: bodies are usually most of the response size. links.next / links.prev keep the setting. Defaults to false.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"links": {
"first": "example",
"next": "example",
"prev": "example"
}
},
"has_more": false,
"next_cursor": null
}List prospects
List the workspace's prospects, one page at a time, from its CRM (Salesforce or HubSpot) and from Nooks itself; the source field says which. Prospects from other sequencing tools are not included. You can filter by prospect ID, sequence enrollment or account.
Inputs
- Page size
page_sizenumber - Number of items per page (max 100)From 1 to 100.
- Page after
page_aftertext - 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.
- Page before
page_beforetext - 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.
- Filter id
filter_idtext - Filter by IDs (comma-separated UUIDs). An empty value is treated as "no filter".
- Filter name
filter_nametext - Filter prospects by exact name match
- Filter title
filter_titletext - Filter prospects by exact job title match
- Filter primary email
filter_primary_emailtext - Comma-separated list of email addresses to filter by (up to 10). Returns prospects whose primary email matches any of the provided values.
- Filter crm id
filter_crm_idtext - Filter prospects by CRM external ID
- Filter sequence id
filter_sequence_idtext - Filter prospects enrolled in a specific sequence
- Filter account id
filter_account_idtext - Filter prospects associated with a specific account
- Filter updated at gte
filter_updated_at_gtedate and time - Filter prospects updated at or after this timestamp (ISO 8601)
- Filter updated at lte
filter_updated_at_ltedate and time - Filter prospects updated at or before this timestamp (ISO 8601)
- Include
includelist - Comma-separated relations to expand inline. Valid values: sequenceStates, phoneNumbers. Max 6. phoneNumbers adds the prospect's dialable phone numbers (the PhoneNumber schema). During the beta it needs the Enrichment API enabled for the workspace; otherwise the request answers 403 INSUFFICIENT_PERMISSION. account is not yet includable. Fetch it via the _href on the account reference instead.One or more of:
sequenceStates,phoneNumbers. - Include crmcustom fields
include_crmcustom_fieldstext - When true, each returned record's crmCustomFields carries the record's CRM custom fields as a single JSON object keyed by the CRM field id/key (e.g. {"hs_lead_status": "OPEN"}). Values are typed per the CRM field's data type (string, number, boolean, string array, or ISO-8601 date string, so a date field's value is not distinguishable from a string field's on the wire). A registered field with no stored value is null. Only fields with a currently-registered CRM attribute definition in the workspace are returned. The field itself is always present in responses; without this opt-in (the default) it is an empty object {} and no custom-field data is fetched.One of:
true,false.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"links": {
"first": "example",
"next": "example",
"prev": "example"
}
},
"has_more": false,
"next_cursor": null
}List sequence states
List sequence enrollments, one page at a time. You can filter by sequence, prospect, account and state.
Inputs
- Page size
page_sizenumber - Number of items per page (max 100)From 1 to 100.
- Page after
page_aftertext - 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.
- Page before
page_beforetext - 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.
- Filter sequence id
filter_sequence_idtext - Filter by sequence ID
- Filter prospect id
filter_prospect_idtext - Filter by prospect ID
- Filter account id
filter_account_idtext - Filter by account ID (matches the prospect's account).
- Filter state
filter_statelist - Filter by state (comma-separated). Valid values: active, paused, finished, pending_startOne or more of:
active,paused,finished,pending_start. - Include
includelist - Comma-separated relations to expand inline. Valid values: sequence, prospect, creator, sequenceStep. Max 6.One or more of:
sequence,prospect,creator,sequenceStep. - Filter updated at gte
filter_updated_at_gtedate and time - Filter by minimum updatedAt (ISO 8601 datetime)
- Filter updated at lt
filter_updated_at_ltdate and time - Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"links": {
"first": "example",
"next": "example",
"prev": "example"
}
},
"has_more": false,
"next_cursor": null
}List sequences
List sequences, one page at a time.
Inputs
- Page size
page_sizenumber - Number of items per page (max 100)From 1 to 100.
- Page after
page_aftertext - 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.
- Page before
page_beforetext - 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.
- Filter name
filter_nametext - Filter sequences by exact name match
- Filter type
filter_typetext - Filter by sequence type. Valid values: date, intervalOne of:
date,interval. - Filter parent sequence id
filter_parent_sequence_idtext - Filter by parent sequence. Pass a sequence id to list that sequence's LinkedIn connection-request follow-up sequences, or null to list only sequences that are not a follow-up of another sequence.
- Include
includelist - Comma-separated relations to expand inline (owner, sequenceSteps). Max 6.One or more of:
owner,sequenceSteps. - Filter updated at gte
filter_updated_at_gtedate and time - Filter by minimum updatedAt (ISO 8601 datetime)
- Filter updated at lt
filter_updated_at_ltdate and time - Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"links": {
"first": "example",
"next": "example",
"prev": "example"
}
},
"has_more": false,
"next_cursor": null
}List tasks
List tasks, one page at a time. A task is one outreach activity, such as a call or email, assigned to a user.
Inputs
- Page size
page_sizenumber - Number of items per page (max 100)From 1 to 100.
- Page after
page_aftertext - 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.
- Page before
page_beforetext - 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.
- Filter id
filter_idtext - Filter by IDs (comma-separated UUIDs). An empty value is treated as "no filter".
- Filter sequence id
filter_sequence_idtext - Filter tasks belonging to a specific sequence
- Filter sequence step id
filter_sequence_step_idtext - Filter tasks tied to a specific sequence step
- Filter prospect id
filter_prospect_idtext - Filter tasks for a specific prospect
- Filter account id
filter_account_idtext - Filter tasks associated with a specific account. Joins through the task's prospect (Prospect.accountId).
- Filter owner id
filter_owner_idtext - Filter tasks assigned to a specific user
- Filter action
filter_actionlist - Filter by action type (comma-separated). Valid values: call, manual_email, auto_email, manual_email_reply, auto_email_reply, basic_task, linkedin_connection_request, manual_linkedin_connection_request, manual_linkedin_message, automatic_linkedin_message, manual_inmail, manual_sms, auto_smsOne or more of:
call,manual_email,auto_email,manual_email_reply,auto_email_reply,basic_task,linkedin_connection_request,manual_linkedin_connection_request,manual_linkedin_message,automatic_linkedin_message, and 3 more. - Filter status
filter_statuslist - Filter by status (comma-separated). Valid values: pending, ready, finished, skipped, failedOne or more of:
pending,ready,finished,skipped,failed. - Filter priority
filter_prioritylist - Filter by priority (comma-separated). Valid values: low, normal, high, urgentOne or more of:
low,normal,high,urgent. - Filter due at gte
filter_due_at_gtedate and time - Filter tasks due at or after this timestamp (ISO 8601)
- Filter due at lte
filter_due_at_ltedate and time - Filter tasks due at or before this timestamp (ISO 8601)
- Filter completed
filter_completedtext - Filter by completion state. Valid values: true, falseOne of:
true,false. - Filter sequence state state
filter_sequence_state_statelist - Filter by the state of the task's sequence state (comma-separated). Valid values: active, paused, finished, null. The sentinel null matches one-off tasks not associated with a sequence.One or more of:
active,paused,finished,null. - Filter updated at gte
filter_updated_at_gtedate and time - Filter by minimum updatedAt (ISO 8601 datetime)
- Filter updated at lt
filter_updated_at_ltdate and time - Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)
- Include
includelist - Comma-separated relations to expand inline. Valid values: owner, prospect, sequence, sequenceState, sequenceStep, email. Max 6. With OAuth, email also requires the emails:read scope (403 without it).One or more of:
owner,prospect,sequence,sequenceState,sequenceStep,email.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"links": {
"first": "example",
"next": "example",
"prev": "example"
}
},
"has_more": false,
"next_cursor": null
}List users
List the users in the workspace who have a seat, one page at a time.
Inputs
- Page size
page_sizenumber - Number of items per page (max 100)From 1 to 100.
- Page after
page_aftertext - 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.
- Page before
page_beforetext - 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.
- Filter name
filter_nametext - Filter users by exact name match
- Filter email
filter_emailtext - Filter users by exact email match.
- Filter crm id
filter_crm_idtext - Filter to the Nooks user mapped to the given id in the customer's CRM (e.g. a Salesforce User.Id or OwnerId). Resolved via the workspace's CRM user mappings. Returns an empty list if no Nooks user is mapped to the given id.
- Filter updated at gte
filter_updated_at_gtedate and time - Filter by minimum updatedAt (ISO 8601 datetime)
- Filter updated at lt
filter_updated_at_ltdate and time - Filter by updatedAt before this timestamp, exclusive (ISO 8601 datetime)
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"data": [],
"links": {
"first": "example",
"next": "example",
"prev": "example"
}
},
"has_more": false,
"next_cursor": null
}Update a task
Update one or more fields of a task.
Inputs
- Task
task_idtextRequired - Unique identifier for the task
- Due at
due_atdate and time - New due date/time for the task (ISO 8601 with timezone offset)
- Owner
owner_idtext - ID of the user to reassign the task to (Firebase UID)
- Priority
prioritytext - New priority level for the taskOne of:
low,normal,high,urgent. - Note
notetext - Updated note for the task. Set to null to clear. On a manual_linkedin_message sequence task, this sets this prospect's LinkedIn message; clear it to use the step's template.
Outputs
Response.
dataobject- The response returned by the service.
has_moretrue/false- Whether another page is available.
next_cursortext- Pass to the continuation input to read the next page.
Example output
{
"data": {
"action": "call",
"completed": false,
"createdAt": "2026-11-13T12:00:00Z",
"dueAt": "2026-11-13T12:00:00Z",
"email": {
"_href": "example",
"id": "example"
},
"id": "00000000-0000-4000-8000-000000000001",
"note": "example",
"owner": {
"_href": "example",
"id": "example"
},
"priority": "low",
"prospect": {
"_href": "example",
"id": "example"
},
"sequence": {
"_href": "example",
"id": "example"
},
"sequenceState": {
"_href": "example",
"id": "example"
},
"sequenceStep": {
"_href": "example",
"id": "example"
},
"status": "example",
"updatedAt": "2026-11-13T12:00:00Z"
},
"has_more": false,
"next_cursor": null
}