---
title: "Get Toll-Free Campaign Status"
method: GET
path: "/status/toll-free-campaign/{campaignId}"
tags: ["status > get"]
---

# Get Toll-Free Campaign Status

`GET /status/toll-free-campaign/{campaignId}`

## Request

- Base URL: `https://api.pinnacle.sh`
- URL: `https://api.pinnacle.sh/status/toll-free-campaign/{campaignId}`
- Auth: API key in header `PINNACLE-API-KEY`

Retrieve a toll-free campaign's status.

## Path parameters

- `campaignId` string, required

## Response `200`

Successfully retrieved.

- GetTollFreeCampaignStatusResponse: Response for get toll-free campaign status.
  - `error` string: Summary of errors related to the verification process. <br> These errors may request additional information or point out erroneous and/or missing fields.
  - `id` string, required: The unique identifier of the toll-free campaign. This identifier is a string that always begins with the prefix `tf_`, for example: `tf_1234567890`.
  - `updates` GetTollFreeCampaignStatusResponseUpdates, required: Status of phone numbers that are being attached to this campaign. <br> Note that phone numbers can only be attached to `VERIFIED` campaigns via the [attach campaign endpoint](../phone-numbers/attach-campaign).
    - `errors` string[], required: List of errors that occurred.
    - `number` string, required: Number associated with the campaign in E.164 format.
    - `status` 'WAITING_FOR_PROVIDER' | 'WAITING_FOR_CUSTOMER' | 'WAITING_FOR_TELECO' | 'IN_PROGRESS' | 'VERIFIED' | 'REJECTED', required: Current assignment status of the toll free number to this campaign. `IN_PROGRESS`: Being reviewed. `WAITING_FOR_PROVIDER`: Being reviewed by our toll-free vendor. `WAITING_FOR_TELECO`: Final review by carriers before number is live. `VERIFIED`: Verified and ready to send messages. `REJECTED`: Issues were found related to your campaign.

## Other responses

- `400`: The request was unacceptable, often due to providing an invalid update. <br> Errors may originate from invalid payload or from Pinnacle's additional validation checks. For example, providing an URL that cannot be accessed, updating a campaign that is currently being reviewed, updating data that you cannot access, sending a malformed message, and so on. <br> For `Pinnacle Validation Error` inspect the `error` payload to determine the source of the failure. These errors are likely due to additional validation and business logic checks.<br> For `Request Validation Error` inspect the `description` and `errors` payload to determine the source of failure. These errors are likely due to invalid payload inside the request.
- `401`: The request lacks valid authentication credentials or the provided credentials are invalid. <br> Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.
- `403`: Your subscription does not include access to this feature. <br> This occurs when attempting to use functionality that requires a higher subscription tier. Please upgrade your subscription to access this feature.
- `404`: The requested resource could not be found. <br> This may occur if the identifier is incorrect, the resource has been deleted, or you don't have permission to access it.
- `500`: An unexpected error occurred on Pinnacle's servers while processing your request. <br> If this error persists, please contact support with the request details.
- `501`: The requested functionality is not implemented on the server. <br> This typically indicates that the feature or endpoint you attempted to access is unavailable or not yet supported.

---

[API](https://skmtc.dev/pinnacle/apis/pinnacle-2.md) - [All operations](https://skmtc.dev/pinnacle/apis/pinnacle-2/llms.txt) - [OpenAPI document](https://skmtc.dev/pinnacle/apis/pinnacle-2/revisions/45416dadab79?raw)