> ## Documentation Index > Fetch the complete documentation index at: https://docs.emailx.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get a campaign > Returns a campaign with its status and steps, plus the link to open it in Emailx. Permission: `campaigns:read` ## OpenAPI ````yaml openapi/emailx.en.json GET /workspaces/{workspace_id}/campaigns/{channel}/{campaign_id} openapi: 3.0.3 info: title: Emailx API version: 1.0.0-beta description: >- Customer and agency integrations for Emailx. Beta access is operator-issued. The v1 beta supports bounded People CSV/XLSX imports, saved email-template settings, selected email generation with explicit AI-credit confirmation, exact-message approval, reviewed email activation for native scheduled sending, and explicitly confirmed inbox replies bound to saved context when host capabilities permit. Inbox context is bounded and may be incomplete or stale; no provider refresh occurs. Manual LinkedIn imports, reviewed activation and reviewed resume of paused campaigns are separate gated workflows. Reply drafts, knowledge, team, infrastructure quotes with hosted checkout and agency administration are covered by separate scopes. Signed webhooks report durable operation outcomes. It does not support immediate batches or direct card charges. servers: - url: https://app.emailx.ai/api/v1 description: Emailx application ยท access must be enabled security: [] tags: - name: Getting started - name: Workspaces - name: Contacts - name: Templates - name: Campaigns - name: Inbox - name: Senders - name: Team - name: Analytics - name: Imports - name: Operations - name: Knowledge - name: Infrastructure - name: Agency paths: /workspaces/{workspace_id}/campaigns/{channel}/{campaign_id}: get: tags: - Set up a campaign summary: Get a campaign description: >- Returns a campaign with its status and steps, plus the link to open it in Emailx. Permission: `campaigns:read` operationId: get_api_campaign parameters: - name: workspace_id in: path required: true schema: type: integer minimum: 1 description: Emailx workspace (Clients) ID, not the agency workspace link ID. - name: channel in: path required: true schema: type: string enum: - email - linkedin description: Resource identifier. - name: campaign_id in: path required: true schema: type: integer minimum: 1 description: Resource identifier. responses: '200': description: Success headers: X-Request-Id: schema: type: string Emailx-Api-Version: schema: type: string X-RateLimit-Limit: schema: type: string X-RateLimit-Remaining: schema: type: string X-RateLimit-Reset: schema: type: string content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/CampaignDetail' required: - data example: data: id: 456 workspace_id: 123 channel: linkedin name: Example Studio outreach status: draft created_at: '2026-10-31T09:00:00Z' review_path: /linkedin-campaign-new/456 audience: Partnership leads in Italian software companies steps: [] '400': description: Request error content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Invalid, expired or revoked API key content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Insufficient scope or write permission content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource missing or inaccessible content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Conflict, concurrent request or uncertain original result content: application/json: schema: $ref: '#/components/schemas/Error' headers: Retry-After: schema: type: string description: Seconds to wait when present. '413': description: Request error content: application/json: schema: $ref: '#/components/schemas/Error' '415': description: Request error content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Rate limited; respect Retry-After content: application/json: schema: $ref: '#/components/schemas/Error' headers: Retry-After: schema: type: string description: Seconds to wait when present. '500': description: Request error content: application/json: schema: $ref: '#/components/schemas/Error' '503': description: API disabled, request storage unavailable or feature not enabled content: application/json: schema: $ref: '#/components/schemas/Error' headers: Retry-After: schema: type: string description: Seconds to wait when present. security: - BearerAuth: [] x-codeSamples: - lang: cURL source: >- curl -X GET "https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456" \ -H "Authorization: Bearer $EMAILX_API_KEY" - lang: Python source: |- import os, requests response = requests.get( "https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456", headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"]}, timeout=30, ) response.raise_for_status() print(response.json()) - lang: JavaScript source: >- const response = await fetch("https://app.emailx.ai/api/v1/workspaces/123/campaigns/linkedin/456", { method: "GET", headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}` }, signal: AbortSignal.timeout(30000), }); if (!response.ok) throw new Error(`Emailx: ${response.status}`); console.log(await response.json()); components: schemas: CampaignDetail: type: object properties: id: type: integer minimum: 1 workspace_id: type: integer minimum: 1 channel: type: string enum: - email - linkedin name: type: string status: type: string created_at: type: string nullable: true format: date-time review_path: type: string audience: type: string nullable: true steps: type: array items: type: object properties: sequence_number: type: integer minimum: 0 type: type: string nullable: true message: type: string nullable: true label: type: string nullable: true wait_days: type: integer nullable: true required: - id - workspace_id - channel - name - status Error: type: object properties: error: type: object properties: code: type: string message: type: string request_id: type: string details: type: object additionalProperties: true required: - code - message - request_id required: - error securitySchemes: BearerAuth: type: http scheme: bearer description: >- ex_test_ or ex_live_ key issued by an Emailx operator. Never use provider keys or session cookies. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.