> ## Documentation Index > Fetch the complete documentation index at: https://developer.mailbeast.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a campaign > Full config - schedule, settings, sequence steps, attached accounts, headline metrics. Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`. ## OpenAPI ````yaml /openapi.json get /v1/campaigns/{id} openapi: 3.0.0 info: title: MailBeast Public API description: >- Task-shaped REST API for campaigns, leads, deliverability, verification and lead discovery. Authenticate with an API key (`Authorization: Bearer mb_live_…`); the workspace is resolved from the key. version: '1' contact: {} servers: - url: https://api.mailbeast.ai security: [] tags: - name: API Keys description: Create, list and revoke API keys programmatically. - name: Campaigns description: Create, configure, launch and monitor email campaigns. - name: Leads description: Add, read, update and bulk-manage a campaign’s leads. - name: Workspace description: Read usage, subscription and workspace identity. - name: Email Accounts description: >- Connect and manage the sending mailboxes your campaigns send from (SMTP/IMAP or native OAuth). - name: Analytics description: Engagement reporting – per campaign, over time, and across the workspace. - name: Lead Finder description: >- Discover new companies and leads. List past searches and poll a running search’s progress. paths: /v1/campaigns/{id}: get: tags: - Campaigns summary: Get a campaign description: >- Full config - schedule, settings, sequence steps, attached accounts, headline metrics. Requires one of the following scopes: `campaigns:read`, `campaigns:all`, `all:read`, `all:all`. operationId: campaigns_get parameters: - name: id required: true in: path schema: type: string format: uuid example: a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60 responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CampaignApiDto' '400': description: The request body or parameters failed validation. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: invalid_request_error code: validation_failed message: One or more fields are invalid. status: 400 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f details: - name should not be empty '401': description: Missing or invalid API key. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: authentication_error code: unauthenticated message: Missing or invalid API key. status: 401 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f '403': description: >- The key lacks a required scope, or the plan does not include API access. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: authorization_error code: permission_denied message: This API key is missing the required scope. status: 403 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f '404': description: The resource does not exist in your workspace. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: invalid_request_error code: not_found message: Resource not found. status: 404 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f '429': description: >- Rate limit exceeded - retry after the interval in the Retry-After header. content: application/json: schema: $ref: '#/components/schemas/ApiErrorDto' example: error: type: rate_limit_error code: rate_limited message: >- Too many requests. Retry after the interval in the Retry-After header. status: 429 requestId: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f retryAfter: 30 security: - ApiKey: [] components: schemas: CampaignApiDto: type: object properties: id: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 name: type: string example: Q4 Product Launch Outreach status: type: string enum: - draft - scheduled - active - paused - stopped - completed - failed example: draft schedule: $ref: '#/components/schemas/CampaignScheduleView' settings: $ref: '#/components/schemas/CampaignSettingsView' metrics: $ref: '#/components/schemas/CampaignMetricsView' sequence: description: >- The email sequence steps - included on the detail view (GET /v1/campaigns/:id). type: array items: $ref: '#/components/schemas/CampaignSequenceStepView' accounts: description: Attached SMTP account ids - included on the detail view. example: - 3f1c2b7e-9a4d-4e18-b2c1-6d8f5a0e7c93 type: array items: type: string tags: description: >- Tags on this campaign - the same ones the list returns, and the same ids `?tags=` filters by. Create and delete them in the dashboard. Campaign tags are a separate dictionary from mailbox tags, so the ids do not cross over. type: array items: $ref: '#/components/schemas/TagApiDto' createdAt: type: string format: date-time example: '2026-07-11T08:00:00.000Z' updatedAt: type: string format: date-time example: '2026-07-11T10:30:00.000Z' required: - id - name - status - schedule - settings - metrics - tags - createdAt - updatedAt ApiErrorDto: type: object properties: error: $ref: '#/components/schemas/ApiErrorBodyDto' required: - error CampaignScheduleView: type: object properties: timezone: type: string example: America/New_York sendingDays: example: - 1 - 2 - 3 - 4 - 5 type: array items: type: number sendingMinutesStart: type: number example: 540 description: Minutes from midnight. sendingMinutesEnd: type: number example: 1020 description: Minutes from midnight. dailyLimit: type: number example: 50 startDate: type: string format: date-time nullable: true endDate: type: string format: date-time nullable: true required: - timezone - sendingMinutesStart - sendingMinutesEnd - dailyLimit CampaignSettingsView: type: object properties: trackOpens: type: boolean example: true trackClicks: type: boolean example: true sendAsTextOnly: type: boolean example: false stopOnReply: type: boolean example: true required: - trackOpens - trackClicks - sendAsTextOnly - stopOnReply CampaignMetricsView: type: object properties: leadsCount: type: number example: 150 sent: type: number example: 120 description: Emails sent. opens: type: number example: 90 description: Open events. clicks: type: number example: 25 description: Click events. replies: type: number example: 12 description: Replies received. required: - leadsCount - sent - opens - clicks - replies CampaignSequenceStepView: type: object properties: subject: type: string example: Quick question about {{companyName}} body: type: string example:

Hi {{firstName}}, …

delayDays: type: number example: 0 delayHours: type: number example: 0 required: - subject - body - delayDays - delayHours TagApiDto: type: object properties: id: type: string format: uuid example: 5c9b1e77-2f4a-4c31-9d8e-1a2b3c4d5e6f name: type: string example: client-acme color: type: string nullable: true example: '#4F46E5' description: Hex colour shown in the dashboard. required: - id - name - color ApiErrorBodyDto: type: object properties: type: type: string example: authorization_error description: Broad error class. code: type: string example: permission_denied description: Stable machine-readable code to switch on. message: type: string example: This API key is missing the required scope. status: type: number example: 403 requestId: type: string example: e4f1c0b2-6a3d-4b8e-9f21-0a1b2c3d4e5f description: Correlation id - quote it in support requests. details: description: Field-level validation messages (present on validation errors). example: - name should not be empty type: array items: type: string retryAfter: type: number description: Seconds to wait before retrying (present on 429 responses). example: 30 required: - type - code - message - status - requestId securitySchemes: ApiKey: scheme: bearer bearerFormat: mb_live_… type: http ```` ## Related topics - [Campaigns](/campaigns.md) - [Get a mailbox](/api-reference/email-accounts/get-a-mailbox.md) - [Authentication](/authentication.md) - [Get a lead](/api-reference/leads/get-a-lead.md) - [Get an email](/api-reference/emails/get-an-email.md)