Your campaigns, newest first, with how many leads each has brought

GET

/v1/campaigns

const url = 'https://api.threadkite.app/v1/campaigns?includeArchived=false';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.threadkite.app/v1/campaigns?includeArchived=false' \
  --header 'Authorization: Bearer <token>'

A campaign is made the first time a lead names it: its utm_campaign (or utm_id), or the campaign of the lead ad it came through. Leads are counted in the inboxes you can see.

Authorizations

api_key
reports:read

Parameters

Query Parameters

includeArchived

Include archived campaigns (Reports > Campaigns); pickers leave it out

boolean

Include archived campaigns (Reports > Campaigns); pickers leave it out

Responses

200

application/json

object

campaigns

required

Newest first

Array<object>

object

required

string format: uuid

name

required

string

platform

required

The ad platform, as far as its leads’ tracking says

string

Allowed values: google microsoft meta tiktok email other

externalId

required

The platform’s campaign id (utm_id), when a lead carried one

string

nullable

leads

required

Leads from this campaign, ever (test leads left out)

number

firstLeadAt

required

string format: date-time

nullable

archivedAt

required

Archived campaigns leave pickers and filters; their leads keep them

string format: date-time

nullable

createdAt

required

string format: date-time

Example

{
  "campaigns": [
    {
      "name": "Spring sale",
      "platform": "google"
    }
  ]
}

401

Missing or invalid API key

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

402

The organisation is on the Free plan (code upgrade_required)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

feature

required

The feature that needs Pro

string

nullable

Allowed values: extraSeats connections aiAssistant aiReplies rules fullReports api inboxes bulkMessages videoMessages

upgradePath

required

Where to upgrade or pay, in the web app

string

Example

{
  "statusCode": 402,
  "code": "upgrade_required",
  "message": "Connections are part of Pro. Upgrade to connect texts, calls and more.",
  "feature": "extraSeats",
  "upgradePath": "/settings/billing"
}

403

The key does not have the scope (or the person the permission)

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

errors

With code invalid: every problem with the request, by field (message is the first)

Array<object>

object

path

required

Dotted path inside the item, e.g. attributes.price.amountMinor

string

message

required

string

Example

{
  "statusCode": 403,
  "code": "forbidden",
  "message": "You do not have permission to do that.",
  "errors": [
    {
      "message": "Enter the make"
    }
  ]
}

429

Rate limit reached

application/json

object

statusCode

required

number

code

required

Stable machine-readable reason

string

message

required

string

retryAfter

required

Seconds until another request will be accepted

number

Example

{
  "statusCode": 429,
  "code": "rate_limited",
  "message": "Too many requests. Each key can make 120 requests a minute; try again in 12 seconds.",
  "retryAfter": 12
}