TEtextla
Campaigns

List campaigns

Returns the account's campaigns, including ones created in the portal, filtered by status, tag, group, keyword or sender. Results are cursor-paginated: next_cursor is null on the last page.

get/campaigns

Request

  • Base URL
    https://api.textla.com/v1
  • Auth
    HTTP bearer

Query parameters

cursorstring

Opaque token from a previous response's next_cursor, to fetch the next page. Omit for the first page.

groupstring

Only campaigns whose audience includes this group.

keywordstring

Only campaigns whose audience includes this keyword.

phone_numberstring

Only campaigns sent from this number.

status'active' | 'canceled' | 'complete' | 'failed' | 'paused' | 'pending_approval' | 'rejected' | 'sent'

Only campaigns with this status.

tagstring

Only campaigns whose audience includes this tag.

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

next_cursorstring nullable required

Cursor for the next page; null on the last page.

Example response

{
  "$schema": "/v1/schemas/ListCampaignsOutput.json",
  "items": [
    {
      "$schema": "/v1/schemas/Campaign.json"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.