Skip to content
  • There are no suggestions because the search field is empty.

How to retrieve active campaigns for a company using the Phin Public API

Use the Phin Public API to list a company’s active campaigns, including campaign type, enrolled user count, schedule, recurrence, and end date

The Get Active Campaigns endpoint returns all currently active campaigns for a specific company under your partner account. Use it to sync campaign status into your PSA, reporting dashboard, or other integrations.

This endpoint returns company level campaigns and also includes partner level shared campaigns noted by the isSharedCampaign field.

ENDPOINT

GET /partners/{partnerId}/companies/{companyId}/campaigns

Path parameters:

  partnerId (required)
    Your Phin partner ID.

  companyId (required)
    The company (client) ID within your partner account.


EXAMPLE REQUEST

curl -s \
  "https://api.phinsec.io/partners/{partnerId}/companies/{companyId}/campaigns"


EXAMPLE RESPONSE (HTTP 200)

{
  "activeCampaignCount": 2,
  "campaigns": [
    {
      "id": "Am9AzrIaiaMlxHccH8es",
      "name": "testing dynamic onboarding",
      "type": "Training - Onboarding",
      "enrolledUserCount": 4,
      "nextFireTimestamp": null,
      "recurrence": null,
      "endTime": null,
       "isSharedCampaign": false

          },
    {
      "id": "CiQBYz48iBmhaSH0KISQ",
      "name": "continuous training campaign",
      "type": "Training - Continuous",
      "enrolledUserCount": 0,
      "nextFireTimestamp": "2025-09-20T10:00:00.000",
      "recurrence": "Monthly",
      "endTime": null,
      "isSharedCampaign": true 

          }
  ]
}