# Retrieve a Campaign

GET https://YOUR_SPACE.signalwire.com/api/relay/rest/registry/beta/campaigns/{id}

Retrieves the details of a campaign.

#### Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Numbers_.

[Learn more about API scopes](/docs/platform/your-signalwire-api-space).

Reference: https://signalwire.com/docs/apis/relay-rest/campaign-registry/retrieve-campaign

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: relay-rest
  version: 1.0.0
paths:
  /registry/beta/campaigns/{id}:
    get:
      operationId: retrieve-campaign
      summary: Retrieve a Campaign
      description: >-
        Retrieves the details of a campaign.


        #### Permissions


        The API token used to authenticate must have the following scope(s)
        enabled to make a successful request: _Numbers_.


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).
      tags:
        - subpackage_campaignRegistry
      parameters:
        - name: id
          in: path
          description: Unique ID of the campaign.
          required: true
          schema:
            $ref: '#/components/schemas/uuid'
        - name: Authorization
          in: header
          description: >-
            SignalWire Basic Authentication using Project ID and API Token.


            The client sends HTTP requests with the Authorization header
            containing

            the word Basic followed by a space and a base64-encoded string of
            project_id:token.

            The project ID will be used as the username and the API token as the
            password.


            Example:

            ```

            Authorization: Basic base64(project_id:token)

            ```
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
servers:
  - url: https://YOUR_SPACE.signalwire.com/api/relay/rest
components:
  schemas:
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
      title: uuid
    CampaignResponse:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
          description: The unique identifier of the campaign.
        name:
          type: string
          description: A name for the campaign.
        state:
          type: string
          description: The current state of the campaign.
        sms_use_case:
          type: string
          description: >-
            An SMS Use Case category for the campaign (2FA,
            ACCOUNT_NOTIFICATION, AGENTS_FRANCHISES, CARRIER_EXEMPT, CHARITY,
            CUSTOMER_CARE, DELIVERY_NOTIFICATION, EMERGENCY, FRAUD_ALERT,
            HIGHER_EDUCATION, K12_EDUCATION, LOW_VOLUME_MIXED, MARKETING, MIXED,
            POLITICAL, POLITICAL_SECTION_527, POLLING_VOTING, PROXY,
            PUBLIC_SERVICE_ANNOUNCEMENT, SECURITY_ALERT, SOCIAL, SWEEPSTAKE,
            TRIAL, UCAAS_HIGH_VOLUME, UCAAS_LOW_VOLUME).
        sub_use_cases:
          type: array
          items:
            type: string
          description: >-
            A sub use case category for MIXED or LOW_VOLUME_MIXED campaigns
            (CUSTOMER_CARE, HIGHER_EDUCATION, POLLING_VOTING,
            PUBLIC_SERVICE_ANNOUNCEMENT, MARKETING, SECURITY_ALERT, 2FA,
            ACCOUNT_NOTIFICATION, DELIVERY_NOTIFICATION, FRAUD_ALERT).
        campaign_verify_token:
          type: string
          description: >-
            Campaign Verify token. Required if sms use case is
            POLITICAL_SECTION_527.
        description:
          type: string
          description: A description for the campaign. Please use at least 40 characters.
        sample1:
          type: string
          description: >-
            Sample message template/content. At least two samples are required
            and up to five can be provided. Please use at least 20 characters.
        sample2:
          type: string
          description: Sample 2.
        sample3:
          type: string
          description: Sample 3.
        sample4:
          type: string
          description: Sample 4.
        sample5:
          type: string
          description: Sample 5.
        dynamic_templates:
          type: string
          description: >-
            If your messaging content will be modified in any way beyond what
            you shared in your templates, please describe the nature of how the
            content will change.
        message_flow:
          type: string
          description: >-
            Please describe the call to action/message flow your intended
            recipients will experience.
        opt_in_message:
          type: string
          description: Please share the message subscribers receive when they opt in.
        opt_out_message:
          type: string
          description: Please share the message subscribers receive when they opt out.
        help_message:
          type: string
          description: Please share the message subscribers receive when they request help.
        opt_in_keywords:
          type: string
          default: START
          description: Opt in keywords that subscribers can use.
        opt_out_keywords:
          type: string
          default: STOP
          description: Opt out keywords that subscribers can use.
        help_keywords:
          type: string
          default: HELP
          description: Help keywords that subscribers can use.
        number_pooling_required:
          type: boolean
          description: >-
            Will 50 or more numbers be used with this single campaign? If so,
            please enter true.
        number_pooling_per_campaign:
          type: string
          description: >-
            If you will be using number pooling, please provide an explanation
            as to why it is needed.
        direct_lending:
          type: boolean
          description: >-
            Will this campaign include content related to direct lending or
            other loan agreements?
        embedded_link:
          type: boolean
          description: >-
            Will you be using an embedded link of any kind? Note that public URL
            shorteners (bitly, tinyurl) will not be accepted.
        embedded_phone:
          type: boolean
          description: >-
            Are you using an embedded phone number (except the required HELP
            information contact phone number)?
        age_gated_content:
          type: boolean
          description: >-
            Will this campaign include any age gated content as defined by
            carrier and CTA guidelines?
        lead_generation:
          type: boolean
          description: Is there any intent of this campaign to generate leads?
        csp_campaign_reference:
          type: string
          description: >-
            If you are your own Campaign Service Provider, what is the approved
            Campaign ID? (Mandatory for CSPs, otherwise please omit)
        status_callback_url:
          type: string
          description: >-
            Optional: Specify a URL to receive webhook notifications when your
            campaign's state changes. See the [10DLC status
            callback](/docs/apis/relay-rest/campaign-registry/webhooks/ten-dlc-status-callback)
            docs for the webhook payload.
        created_at:
          type: string
          format: date-time
          description: Timestamp when the campaign was created.
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the campaign was last updated.
      required:
        - id
      description: Response containing a single campaign.
      title: CampaignResponse
    TypesStatusCodesStatusCode401Error:
      type: string
      enum:
        - Unauthorized
      title: TypesStatusCodesStatusCode401Error
    Types.StatusCodes.StatusCode401:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode401Error'
      required:
        - error
      description: Access is unauthorized.
      title: Types.StatusCodes.StatusCode401
    TypesStatusCodesStatusCode404Error:
      type: string
      enum:
        - Not Found
      title: TypesStatusCodesStatusCode404Error
    Types.StatusCodes.StatusCode404:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode404Error'
      required:
        - error
      description: The server cannot find the requested resource.
      title: Types.StatusCodes.StatusCode404
    TypesStatusCodesStatusCode500Error:
      type: string
      enum:
        - Internal Server Error
      title: TypesStatusCodesStatusCode500Error
    Types.StatusCodes.StatusCode500:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/TypesStatusCodesStatusCode500Error'
      required:
        - error
      description: An internal server error occurred.
      title: Types.StatusCodes.StatusCode500
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: basic
      description: >-
        SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of
        project_id:token.

        The project ID will be used as the username and the API token as the
        password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```

```

## SDK Code Examples

```python
import requests

url = "https://your_space.signalwire.com/api/relay/rest/registry/beta/campaigns/id"

headers = {"Authorization": "Basic <project_id>:<api_token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://your_space.signalwire.com/api/relay/rest/registry/beta/campaigns/id';
const options = {method: 'GET', headers: {Authorization: 'Basic <project_id>:<api_token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your_space.signalwire.com/api/relay/rest/registry/beta/campaigns/id"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <project_id>:<api_token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://your_space.signalwire.com/api/relay/rest/registry/beta/campaigns/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <project_id>:<api_token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://your_space.signalwire.com/api/relay/rest/registry/beta/campaigns/id")
  .header("Authorization", "Basic <project_id>:<api_token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your_space.signalwire.com/api/relay/rest/registry/beta/campaigns/id', [
  'headers' => [
    'Authorization' => 'Basic <project_id>:<api_token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://your_space.signalwire.com/api/relay/rest/registry/beta/campaigns/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Basic <project_id>:<api_token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Basic <project_id>:<api_token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://your_space.signalwire.com/api/relay/rest/registry/beta/campaigns/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```