---
title: "List Campaign Registrations"
method: GET
path: "/v1/projects/{projectId}/campaignRegistrations"
tags: ["10DLC Campaign Registration"]
---

# List Campaign Registrations

`GET /v1/projects/{projectId}/campaignRegistrations`

Lists all campaign registrations per project.

## Path parameters

- `projectId` string, required

## Query parameters

- `status` string[]
- `mock` boolean
- `useCase` string
- `brand` string
- `pageSize` integer
- `pageToken` string
- `orderBy` string

## Response `200`

A successful response.

- ListCampaignRegistrationResponse
  - `campaignRegistrations` CampaignResponse[]
    - `campaignId` string — Campaign ID returned by external partner. i.e. TCR Campaign Id
    - `campaignName` string — Optional name to help track and view campaign.
    - `campaignRegistrationId` string — Campaign Registration Id returned by the Create Campaign API
    - `createDate` string, date-time — Campaign Creation Date
    - `modifiedDate` string, date-time — Campaign Modified Date
    - `createdBy` string — Represents who Created this Campaign
    - `modifiedBy` string — Represents who was the Last to Modify this Campaign
    - `autoRenewal` boolean — Campaign subscription auto-renewal status.
    - `billedDate` string, date-time — Campaign recent billed date.
    - `brandId` string — Alphanumeric identifier of the brand associated with this campaign.
    - `vertical` string — Business/industry segment of this campaign. Must be of defined valid types.
    - `useCase` string — Campaign useCase.
    - `subUseCases` string[] — Campaign sub use-cases.
    - `description` string — Summary description of this campaign.
    - `embeddedLink` boolean — Does message generated by the campaign include URL link in SMS?
    - `embeddedPhone` boolean — Does message generated by the campaign include phone number in SMS?
    - `affiliateMarketing` boolean — Does message content controlled by affiliate marketing other than the brand?
    - `numberPool` boolean — Indicates whether this campaign has been approved and configured as a numberpool campaign
    - `ageGated` boolean — Age gated content in campaign.
    - `directLending` boolean — is direct lending.
    - `subscriberOptIn` boolean — Does campaign require subscriber to opt-in before SMS is sent to subscriber?
    - `subscriberOptOut` boolean — Does campaign support subscriber opt-out keyword(s)?
    - `subscriberHelp` boolean — Does campaign responds to help keyword(s)?
    - `sample1` string — Message sample. Some campaign tiers require 1 or more message samples.
    - `sample2` string — Message sample. Some campaign tiers require 2 or more message samples.
    - `sample3` string — Message sample. Some campaign tiers require 3 or more message samples.
    - `sample4` string — Message sample. Some campaign tiers require 4 or more message samples.
    - `stopMessage` string — Message that will be returned if a subscriber opts out of the campaign.
    - `optInMessage` string — Message that will be returned when a subscriber opts into a campaign.
    - `helpMessage` string — Help message of the campaign.
    - `monthlyFee` number, float — Monthly Fee
    - `setupFee` number, float — Initial Setup Fee
    - `status` 'SINCH_REVIEW' | 'SINCH_APPROVED' | 'SINCH_REJECTED' | 'SUBMITTED' | 'APPROVED' | 'ACTIVE' | 'EXPIRED' | 'REJECTED' | 'SUBMISSION_FAILED' — Campaign Status.
    - `mnoMetadata` object
    - `mock` boolean — Defines if campaign mocked or real one
    - `lastActionStatus` 'CREATE_IN_PROGRESS' | 'CREATE_SUCCESSFUL' | 'CREATE_FAILED' | 'DELETE_IN_PROGRESS' | 'DELETE_SUCCESSFUL' | 'DELETE_FAILED' | 'RESUBMIT_IN_PROGRESS' | 'RESUBMIT_SUCCESSFUL' | 'RESUBMIT_FAILED' — Last Action Status.
    - `optinKeywords` string — Subscriber opt-in keywords. Must be upper-case alphanumeric comma(,) separated keywords without space.
    - `optoutKeywords` string — Subscriber opt-out keywords. Default value is 'STOP'. Must be upper-case alphanumeric comma(,) separated keywords without space.
    - `helpKeywords` string — Subscriber help keywords. Default value is 'HELP'. Must be upper-case alphanumeric comma(,) separated keywords without space.
    - `messageFlow` string — Message flow description.
    - `nextRenewalOrExpirationDate` string, date-time — When the campaign would be due for its next renew/bill date.
  - `nextPageToken` string
  - `totalSize` integer

## Other responses

- `400` — If the page_token, number_pattern or order_by is not valid
- `429` — Over limit
- `500` — INTERNAL: Internal server error. Typically, a server bug.

---

[API](https://skmtc.net/sinch/apis/registration.md) · [All operations](https://skmtc.net/sinch/apis/registration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sinch/registration/revisions/9eecb207c30d/schema)