RErecruitwithatlas
Campaigns

List campaigns

Changed on

Returns a paginated list of active outreach campaigns for a given project or opportunity.

get/api/v1/campaigns

Request

Query parameters

entityType'project' | 'opportunity' required

Type of parent entity

Example:project
entityIdstring uuid required

ID of the project or opportunity

Example:550e8400-e29b-41d4-a716-446655440000
pageinteger

Page number

Example:1
pageSizeinteger

Items per page

Example:25

Response

Paginated list of campaigns

status'ok' required

Example response

{
  "data": [
    {
      "name": "Q1 Outreach",
      "status": "active",
      "type": "candidate_outreach",
      "createdAt": "2025-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 25,
    "total": 1,
    "totalPages": 1
  }
}

Changes