Sign in
Campaigns

Get a campaign

Retrieve a single campaign by ID.

get/v1/campaigns/{campaignId}

Response

Successful.

idstring required

The ID of the campaign.

urlstring uri required

The URL of the campaign in the Loops app.

namestring required

The name of the campaign.

status'Draft' | 'Scheduled' | 'Sending' | 'Sent' required

The status of the campaign.

createdAtstring date-time required

ISO 8601 timestamp for when the campaign was created.

updatedAtstring date-time required

ISO 8601 timestamp for when the campaign was last updated.

emailMessageIdstring nullable required

The associated email message ID.

campaignGroupIdstring nullable required

The ID of the campaign group this campaign belongs to.

mailingListIdstring nullable required

The ID of the mailing list this campaign sends to, if set.

audienceSegmentIdstring nullable required

The ID of the audience segment this campaign targets, if set.

Example response

{
  "id": "clc4m6n8p0q2r4s6t8u0v2x4",
  "url": "https://app.loops.so/campaigns/clc4m6n8p0q2r4s6t8u0v2x4",
  "name": "Spring announcement",
  "status": "Draft",
  "createdAt": "2025-06-29T07:47:39.370Z",
  "updatedAt": "2025-06-29T07:47:39.370Z",
  "emailMessageId": "cle5f7g9h1i3j5k7l9m1n3p5",
  "campaignGroupId": "clg7n5p3q1r9s7t5u3v1w9y7",
  "mailingListId": "clm2k8j4h6g0f8d6s4a2b0z8",
  "audienceSegmentId": null,
  "audienceFilter": null,
  "scheduling": {
    "method": "now",
    "timestamp": null
  }
}

Changes

Changed in 2 of the 9 revisions of this API.41

  • 74756bcb2e9e1See the full diff
    • ○

      api operation id getCampaign was added

      api-operation-id-added

  • df77516a130a4See the full diff
    • ●

      added the new Draft enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new Scheduled enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new Sending enum value to the status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new Sent enum value to the status response property for the response status 200

      response-property-enum-value-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 9 revisions, 1 has no diff computed.