---
title: "Get Single Shared Campaign"
method: GET
path: "/10dlc/partner_campaigns/{campaignId}"
tags: ["Shared Campaigns"]
---

# Get Single Shared Campaign

`GET /10dlc/partner_campaigns/{campaignId}`

Retrieve campaign details by `campaignId`.

## Path parameters

- `campaignId` string, required

## Response `200`

Successful Response

- TelnyxDownstreamCampaign — Campaign is generated by the 10DLC registry once the corresponding campaign request is approved. Each campaign is assigned a unique identifier - **campaignId**. Once a campaign is activated, limited information is published to the NetNumber OSR service for consumption by members of the ecosystem. When a campaign is suspended(reversible) or expired(non-reversible), campaign data is deleted from the OSR service.
  - `ageGated` boolean — Age gated content in campaign.
  - `assignedPhoneNumbersCount` number — Number of phone numbers associated with the campaign
  - `brandDisplayName` string — Display or marketing name of the brand.
  - `campaignStatus` 'TCR_PENDING' | 'TCR_SUSPENDED' | 'TCR_EXPIRED' | 'TCR_ACCEPTED' | 'TCR_FAILED' | 'TELNYX_ACCEPTED' | 'TELNYX_FAILED' | 'MNO_PENDING' | 'MNO_ACCEPTED' | 'MNO_REJECTED' | 'MNO_PROVISIONED' | 'MNO_PROVISIONING_FAILED' — Campaign status
  - `description` string — Summary description of this campaign.
  - `directLending` boolean — Direct lending or loan arrangement.
  - `embeddedLink` boolean — Does message generated by the campaign include URL link in SMS?
  - `embeddedLinkSample` string — Sample of an embedded link that will be sent to subscribers.
  - `embeddedPhone` boolean — Does message generated by the campaign include phone number in SMS?
  - `failureReasons` string — Failure reasons if campaign submission failed
  - `helpKeywords` string — Subscriber help keywords. Multiple keywords are comma separated without space.
  - `helpMessage` string — Help message of the campaign.
  - `isNumberPoolingEnabled` boolean — Indicates whether the campaign has a T-Mobile number pool ID associated with it.
  - `messageFlow` string — Message flow description.
  - `numberPool` boolean — Does campaign utilize pool of phone numbers?
  - `optinKeywords` string — Subscriber opt-in keywords. Multiple keywords are comma separated without space.
  - `optinMessage` string — Subscriber opt-in message.
  - `optoutKeywords` string — Subscriber opt-out keywords. Multiple keywords are comma separated without space.
  - `optoutMessage` string — Subscriber opt-out message.
  - `privacyPolicyLink` string — Link to the campaign's privacy policy.
  - `usecase` string — Campaign usecase. Must be of defined valid types. Use `/10dlc/enum/usecase` operation to retrieve usecases available for given brand.
  - `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.
  - `sample5` string — Message sample. Some campaign tiers require 5 or more message samples.
  - `subUsecases` string[] — Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/10dlc/enum/usecase` operation to retrieve list of valid sub-usecases
  - `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)?
  - `tcrBrandId` string, required — Unique identifier assigned to the brand by the registry.
  - `tcrCampaignId` string, required — Unique identifier assigned to the campaign by the registry.
  - `termsAndConditions` boolean — Is terms & conditions accepted?
  - `termsAndConditionsLink` string — Link to the campaign's terms and conditions.
  - `webhookURL` string — Webhook to which campaign status updates are sent.
  - `webhookFailoverURL` string — Failover webhook to which campaign status updates are sent.
  - `createdAt` string — Date and time that the brand was created at.
  - `updatedAt` string — Date and time that the brand was last updated at.

## Other responses

- `422` — Validation Error
- `4XX` — Generic response error

---

[API](https://skmtc.net/team-telnyx/apis/telnyx-api.md) · [All operations](https://skmtc.net/team-telnyx/apis/telnyx-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/team-telnyx/telnyx-api/versions/e32d46c5945b/schema)