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

# Get Campaign Details

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

## Request

- Base URL: `https://us10dlc.numbers.api.sinch.com`
- URL: `https://us10dlc.numbers.api.sinch.com/v1/projects/{projectId}/campaignRegistrations/{campaignRegistrationId}`
- Auth: one of:
  - HTTP basic
  - OAuth 2
    - Client credentials
    - Token URL: `https://auth.sinch.com/oauth2/token`

Returns the details of the specified campaign by its registration ID.

## Path parameters

- `projectId` string, required
- `campaignRegistrationId` string, required

## Response `200`

A successful response.

- 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.

## Other responses

- `400`: INVALID_ARGUMENT: If the input parameters are not valid
- `404`: The campaign could not be found
- `429`: Over limit
- `500`: INTERNAL: Internal server error. Typically, a server bug.

---

[API](https://skmtc.dev/sinch/apis/registration.md) - [All operations](https://skmtc.dev/sinch/apis/registration/llms.txt) - [OpenAPI document](https://skmtc.dev/sinch/apis/registration/revisions/e8ef20787f30?raw)