List campaigns

GET

/api/campaigns

Returns the list of campaigns (companies) belonging to the authenticated user. Uses cursor-based pagination. Results are cached. Filter by status to get only draft, active, paused, or finished campaigns.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200OK

application/json

Successful response

Body

🟠401Unauthorized

🟠422Unprocessable Entity

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/campaigns?per_page&cursor&status' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "success": true,
    "message": "Campaigns retrieved successfully.",
    "data": [
        {
            "id": 1,
            "uuid": "9d8e7f6a-5b4c-3d2e-1f0a-b1c2d3e4f5a6",
            "name": "Q1 2025 Campaign",
            "status": "active",
            "x_username": "acme",
            "started_at": "2019-08-24T14:15:22.123Z",
            "finished_at": "2019-08-24T14:15:22.123Z",
            "credit_limit": 10000
        }
    ],
    "links": {
        "first": "string",
        "last": "string",
        "prev": "string",
        "next": "string"
    },
    "meta": {
        "path": "string",
        "per_page": 15,
        "next_cursor": "string",
        "prev_cursor": "string"
    }
}

Modified at 2026-02-10 16:32:00

Get post ratings

TwitterPostStatistics