GET /api/v1/campaigns/{id}, Get Campaign

Returns full details of a single campaign by ID, including messages, schedule, executor IDs, and current status.

Retrieve a single campaign by its unique identifier. The response includes the full campaign configuration, such as message sequences, schedule windows, assigned executors, and current status.

Path parameters

campaign_id · integer · required

The unique ID of the campaign to retrieve.

Example request

curl -X GET "https://reachowl.com/api/v1campaigns/101" \
  -H "Authorization: Bearer <token>"

Example response

{
  "id": 101,
  "name": "Q3 Outreach",
  "platform": "facebook",
  "action_type": "friend_request",
  "audience_type": "group",
  "post_url": "https://facebook.com/groups/example",
  "status": 1,
  "limit": 30,
  "executor_ids": [3, 7],
  "messages": [
    {
      "text": ["Hello!"],
      "delay": 5
    }
  ],
  "schedule": [
    {
      "day": "monday",
      "start_time": "09:00",
      "end_time": "17:00"
    }
  ],
  "audience_keywords": [],
  "exclude_keywords": [],
  "countries": [],
  "comment_keywords": [],
  "created_at": "2024-01-10T08:00:00Z",
  "updated_at": "2024-01-12T10:30:00Z"
}

id · integer

Unique campaign identifier.

name · string

Campaign name.

platform · string

Social platform targeted by this campaign (for example, facebook).

action_type · string

Outreach action type (for example, friend_request).

audience_type · string

Audience source type (for example, group).

post_url · string

URL of the synced group or post.

status · integer

Campaign status: 0 for paused, 1 for running.

limit · integer

Maximum number of actions the campaign should perform.

executor_ids · array

IDs of the executors assigned to this campaign.

messages · array

Message sequence with text arrays and delays.

schedule · array

Active time windows by day.

audience_keywords · array

Keywords used to filter the audience.

exclude_keywords · array

Keywords used to exclude audience members.

countries · array

Target country codes.

comment_keywords · array

Keywords for comment-based filtering.

created_at · string

ISO 8601 timestamp of when the campaign was created.

updated_at · string

ISO 8601 timestamp of the last update.