Skip to main content
GET
/
campaigns
List campaigns
curl --request GET \
  --url https://inboxapp.com/api/v1/campaigns \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": null,
      "status": "draft",
      "dryRun": true,
      "targetsCount": 123,
      "contactedCount": 123,
      "repliesCount": 123,
      "completionRate": 123,
      "replyRate": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2025-04-28T14:11:10.000Z",
      "pausedAt": null,
      "completedAt": null,
      "lastStartedAt": "2025-04-02T13:45:00.000Z",
      "type": "<unknown>",
      "hourlyMessageRate": 30,
      "scheduleTimezone": "<string>",
      "scheduleHours": {},
      "estimatedTargets": 123,
      "isHydrating": true,
      "isBuildingPlan": true,
      "steps": [
        {
          "id": "<string>",
          "rank": 123,
          "type": "message",
          "data": {
            "segments": [
              {
                "type": "static",
                "text": "<string>"
              }
            ]
          },
          "campaignVersion": 123
        }
      ],
      "lists": [
        {
          "listId": "<string>",
          "exclude": false
        }
      ],
      "accountLinkIds": [
        "<string>"
      ],
      "automations": [
        {
          "id": "<string>",
          "trigger": "<unknown>",
          "action": "<unknown>",
          "actionData": {
            "statusId": "<string>"
          },
          "enabled": true
        }
      ],
      "customVariables": {
        "company-name": {
          "displayName": "Company name",
          "description": null
        }
      }
    }
  ],
  "nextCursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.inboxapp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string

Pagination cursor from a previous response

limit
integer
default:50

Maximum number of campaigns to return per page

Required range: 1 <= x <= 100
Example:

50

status
enum<string>

Filter campaigns by status

Available options:
draft,
active,
paused,
completed
Examples:

"draft"

"active"

"paused"

"completed"

Response

200 - application/json

OK

data
object[]
required
nextCursor
string | null
required

Cursor to fetch the next page. Null if there are no more results.