List Tasks

curl --request GET \
  --url http://api.stuut.ai/v1/tasks \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "label": "<string>",
      "object": "<string>",
      "organization_id": "<string>",
      "type": "activity_summary_outreach",
      "id": "<string>",
      "action_taken": "complete",
      "assignee": {
        "email": "<string>",
        "family_name": "<string>",
        "given_name": "<string>",
        "object": "<string>",
        "organization_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "dashboard_settings": {
          "thread_emails_sort_order": "asc"
        },
        "default_email_sender_id": "<string>",
        "invited_by_user_id": "<string>",
        "is_access_approved": true,
        "is_org_admin": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "onboarding_required": true,
        "profile_picture": "<string>",
        "selected": true
      },
      "assignee_id": "<string>",
      "close_reason": "<string>",
      "completed_action": {},
      "created_at": "2023-11-07T05:31:56Z",
      "data": [
        {
          "object": "<string>",
          "source": "email",
          "task_id": "<string>",
          "type": "response",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "data": "<unknown>",
          "modified_at": "2023-11-07T05:31:56Z"
        }
      ],
      "description": "<string>",
      "error_reason": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "status": "open",
      "trigger_event": {
        "name": "<string>",
        "object": "<string>",
        "id": "<string>",
        "actor_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "data": "<unknown>",
        "entity": "<unknown>",
        "entity_id": "<string>",
        "message": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "trigger_event_id": "<string>"
    }
  ],
  "current_page": 0,
  "total_records": 0,
  "next_page": null
}

GET

tasks

List Tasks

curl --request GET \
  --url http://api.stuut.ai/v1/tasks \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "label": "<string>",
      "object": "<string>",
      "organization_id": "<string>",
      "type": "activity_summary_outreach",
      "id": "<string>",
      "action_taken": "complete",
      "assignee": {
        "email": "<string>",
        "family_name": "<string>",
        "given_name": "<string>",
        "object": "<string>",
        "organization_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "dashboard_settings": {
          "thread_emails_sort_order": "asc"
        },
        "default_email_sender_id": "<string>",
        "invited_by_user_id": "<string>",
        "is_access_approved": true,
        "is_org_admin": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "onboarding_required": true,
        "profile_picture": "<string>",
        "selected": true
      },
      "assignee_id": "<string>",
      "close_reason": "<string>",
      "completed_action": {},
      "created_at": "2023-11-07T05:31:56Z",
      "data": [
        {
          "object": "<string>",
          "source": "email",
          "task_id": "<string>",
          "type": "response",
          "id": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "data": "<unknown>",
          "modified_at": "2023-11-07T05:31:56Z"
        }
      ],
      "description": "<string>",
      "error_reason": "<string>",
      "modified_at": "2023-11-07T05:31:56Z",
      "status": "open",
      "trigger_event": {
        "name": "<string>",
        "object": "<string>",
        "id": "<string>",
        "actor_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "data": "<unknown>",
        "entity": "<unknown>",
        "entity_id": "<string>",
        "message": "<string>",
        "modified_at": "2023-11-07T05:31:56Z",
        "timestamp": "2023-11-07T05:31:56Z"
      },
      "trigger_event_id": "<string>"
    }
  ],
  "current_page": 0,
  "total_records": 0,
  "next_page": null
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

default:0

Page number, 0 indexed.

Required range: x >= 0

limit

integer

default:50

The page size

Required range: 1 <= x <= 200

sort_order

enum<string>

Available options:

asc,

desc

sort_by

enum<string>

Available options:

modified_at,

status,

type,

created_at

status

enum<string>[]

Available options:

open,

completed,

closed,

archived,

failed,

processing,

assigned_to_agent

type

enum<string>

Available options:

activity_summary_outreach,

activity_summary_payments,

auto_response_email,

auto_response_call,

call_analysis,

disable_contact,

recommendation_new_contact,

scheduled_email_approval,

scheduled_call_approval

classification

string[]

partner_id

string

assignee

string

The User identifier, (e.g. usr_abc123).

is_automated

boolean

Response

Successful response

data

object[]

Show child attributes

data.label

string

required

The blurb or label for the task.

data.object

string

required

data.organization_id

string

required

The ID of the organization this task belongs to.

Maximum string length: 32

data.type

enum<string>

required

The type of the task.

Available options:

activity_summary_outreach,

activity_summary_payments,

auto_response_email,

auto_response_call,

call_analysis,

disable_contact,

recommendation_new_contact,

scheduled_email_approval,

scheduled_call_approval

Maximum string length: 26

data.id

string

Maximum string length: 32

data.action_taken

enum<string> | null

The action taken on the task that affected its current state.

Available options:

complete,

complete_with_action,

close,

Maximum string length: 20

data.assignee

object

Show child attributes

data.assignee.email

string

required

Maximum string length: 255

data.assignee.family_name

string

required

data.assignee.given_name

string

required

data.assignee.object

string

required

data.assignee.organization_id

string

required

Maximum string length: 32

data.assignee.id

string

Maximum string length: 32

data.assignee.created_at

string<date-time>

data.assignee.dashboard_settings

object

Show child attributes

data.assignee.dashboard_settings.thread_emails_sort_order

string

default:asc

data.assignee.default_email_sender_id

string | null

Maximum string length: 32

data.assignee.invited_by_user_id

string | null

Maximum string length: 32

data.assignee.is_access_approved

boolean

data.assignee.is_org_admin

boolean

data.assignee.modified_at

string<date-time> | null

data.assignee.name

string

data.assignee.onboarding_required

boolean

data.assignee.profile_picture

string

data.assignee.selected

boolean

data.assignee_id

string | null

The ID of the user assigned to this task, if any.

Maximum string length: 32

data.close_reason

string | null

The reason for closing the task, if not completed.

data.completed_action

object

Option 1
Option 2

data.created_at

string<date-time>

data.data

object[]

Show child attributes

data.data.object

string

required

data.data.source

enum<string>

required

The source of the task data (e.g., 'email', 'phone', 'slack', 'invoice', 'account').

Available options:

email,

phone,

slack,

invoice,

account

Maximum string length: 7

data.data.task_id

string

required

The ID of the task this data belongs to.

Maximum string length: 32

data.data.type

enum<string>

required

The type of task data (e.g., 'response', 'classification', 'analysis', 'summary').

Available options:

response,

classification,

context,

analysis,

summary,

contact,

acknowledge

Maximum string length: 14

data.data.id

string

Maximum string length: 32

data.data.created_at

string<date-time>

data.data.data

any | null

Task data.

data.data.modified_at

string<date-time> | null

data.description

string | null

The contextual description of the task.

data.error_reason

string | null

The reason for task failing, if an error occurred.

data.modified_at

string<date-time> | null

data.status

enum<string>

The current status of the task.

Available options:

open,

completed,

closed,

archived,

failed,

processing,

assigned_to_agent

Maximum string length: 17

data.trigger_event

object

Show child attributes

data.trigger_event.name

string

required

data.trigger_event.object

string

required

data.trigger_event.id

string

Maximum string length: 32

data.trigger_event.actor_id

string | null

Maximum string length: 32

data.trigger_event.created_at

string<date-time>

data.trigger_event.data

unknown

data.trigger_event.entity

any

data.trigger_event.entity_id

string | null

The primary key of the entity that this event is related to, e.g. inv_123 for invoice.created

data.trigger_event.message

string

data.trigger_event.modified_at

string<date-time> | null

data.trigger_event.timestamp

string<date-time>

The time the event occurred (or should occur). This can be set to a future time if the event should be scheduled.

data.trigger_event_id

string | null

The ID of the event that triggered this task, if any.

Maximum string length: 32

current_page

integer

default:0

The current page.

total_records

integer

default:0

Total number of records.

next_page

integer | null

The next page, if one exists.

Delete A Tag Retrieve A Task

⌘I

Analytics

Bank Accounts

Bank Statements

Bank Transactions

Call Agent Scenarios

Call Agents

Calls

Contact Suggestions

Email Senders

Email Template Folders

Email Templates

Email Threads

Emails

Files

Invoices

Notes

Organizations

Outreach Workflows

Partners

Partner Contacts

Payments

Phone Numbers

Profile

Remittances

Tags

Tasks

User Invites

Users

List Tasks

Authorizations

Query Parameters

Response