Skip to main content
GET
/
v1
/
outreach-workflows
List Outreach Workflows
curl --request GET \
  --url http://api.stuut.ai/v1/outreach-workflows \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "active_days": [
        123
      ],
      "name": "<string>",
      "object": "<string>",
      "outreach_window_end": "<string>",
      "outreach_window_start": "<string>",
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "email_sender": {
        "email": "<string>",
        "object": "<string>",
        "reply_to": "<string>",
        "user_id": "<string>",
        "id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "expired_at": "2023-11-07T05:31:56Z",
        "is_nylas_connection": true,
        "is_nylas_grant_expired": true,
        "is_shared": true,
        "modified_at": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "provider": "<string>",
        "reply_to_name": "<string>",
        "signature_html": "<string>"
      },
      "email_sender_id": "<string>",
      "is_active": true,
      "is_call_on_weekend_enabled": true,
      "modified_at": "2023-11-07T05:31:56Z",
      "pending_run_strategy": "send_all",
      "stages": [
        {
          "action": "email",
          "event": "<string>",
          "name": "<string>",
          "object": "<string>",
          "time_trigger": "<string>",
          "workflow_id": "<string>",
          "id": "<string>",
          "auto_send": true,
          "cc": [
            "<string>"
          ],
          "cc_secondary_contacts": true,
          "created_at": "2023-11-07T05:31:56Z",
          "email_template": {
            "object": "<string>",
            "id": "<string>",
            "auto_correct": true,
            "body": "<string>",
            "cc": [
              "<string>"
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "folder_id": "<string>",
            "is_default": true,
            "modified_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "subject": "<string>"
          },
          "external_roles_to_cc": [
            "<string>"
          ],
          "fallback_email_template": {
            "object": "<string>",
            "id": "<string>",
            "auto_correct": true,
            "body": "<string>",
            "cc": [
              "<string>"
            ],
            "created_at": "2023-11-07T05:31:56Z",
            "folder_id": "<string>",
            "is_default": true,
            "modified_at": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "subject": "<string>"
          },
          "internal_roles_to_cc": [
            "<string>"
          ],
          "is_always_run_enabled": true,
          "modified_at": "2023-11-07T05:31:56Z",
          "num_days": 123,
          "outreach_window_end": "<string>",
          "outreach_window_start": "<string>",
          "recurrence_end_offset_days": 123,
          "recurrence_interval_days": 123
        }
      ],
      "test_email": "<string>",
      "test_phone_number": "<string>",
      "timezone": "Africa/Abidjan"
    }
  ],
  "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.

Response

Successful response

data
object[]
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.