RecruitAffiliates.ai

Retrieve a campaign

One campaign with its numbers: members, enrolled, sent, replied, bounced and unsubscribed.

Scope: finder:read (or finder:write)

get/v1/finder/campaigns/{id}

Request

  • Base URL: https://api.affiliaterail.com
  • URL: https://api.affiliaterail.com/v1/finder/campaigns/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Prefixed id (fca_…)

Example:fca_7uSyy9FqVLCFWrdPeZaK

Response

The campaign

idstring required

Prefixed id (fca_…)

object'finder_campaign' required
brand_idstring required

Prefixed id (fbr_…)

inbox_idstring nullable required
namestring required
state'draft' | 'running' | 'paused' | 'stopped' | 'finished' required
approvedboolean required

True once someone approved the current emails in the app

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "fca_7uSyy9FqVLCFWrdPeZaK",
  "brand_id": "fbr_7uSyy9FqVLCFWrdPeZaK",
  "audience": {
    "checked_at": "2026-08-21T10:15:30.000Z"
  },
  "created_at": "2026-08-21T10:15:30.000Z",
  "updated_at": "2026-08-21T10:15:30.000Z"
}

Changes

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