> ## Documentation Index > Fetch the complete documentation index at: https://docs.deliveryman.ai/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Campaign > Fetches details for a single campaign. ## OpenAPI ````yaml /openapi-v1.yml get /api/v1/campaign/ openapi: 3.1.1 info: title: DeliverymanAI API V1 version: 1.0.0 description: >- API documentation for version 1 of the DeliverymanAI API. These endpoints drive campaigns, contact lists, leads and email sequences from your own code. V1 is in maintenance: it keeps working and existing integrations do not need to change, but new features are only added to V2. If you are starting a new integration, use V2. V1 and V2 share the same API keys, sent in the `X-Api-Key` header. servers: - url: https://api.deliveryman.ai description: Deliveryman API Server security: [] paths: /api/v1/campaign/: get: tags: - Campaign summary: Retrieve Campaign description: Fetches details for a single campaign. operationId: campaign_retrieve parameters: - in: query name: campaign_uid schema: type: string description: UID of campaign data to fetch. required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/GetCampaignAPI' description: Success '400': content: application/json: schema: $ref: '#/components/schemas/SimpleMessageResponse' description: Bad Request '404': content: application/json: schema: $ref: '#/components/schemas/SimpleMessageResponse' description: Not Found '500': description: Internal Server Error security: - ApiKeyAuth: [] x-codeSamples: - lang: bash label: curl source: >- curl "https://api.deliveryman.ai/api/v1/campaign/?campaign_uid=cmp_4b1f7a92c3d84e05" \ -H "X-Api-Key: YOUR_API_KEY" components: schemas: GetCampaignAPI: type: object properties: uid: type: string description: Unique identifier of the campaign. maxLength: 255 created_on: type: string format: date-time readOnly: true description: >- Date when the campaign was created. ISO format date string in UTC timezone. workspace_id: type: - integer - 'null' readOnly: true description: The ID of the workspace associated with the campaign. scheduled_start_datetime: type: - string - 'null' format: date-time description: >- Datetime when the campaign is scheduled to start. ISO format date string in UTC timezone. settings: allOf: - $ref: '#/components/schemas/CampaignSettings' readOnly: true status: allOf: - $ref: '#/components/schemas/StatusF69Enum' description: |- Current status of the campaign. * `creating` - Creating * `created` - Created * `scheduled` - Scheduled * `running` - Running * `paused` - Paused * `complete` - Complete * `cancelled` - Cancelled * `failed` - Failed bounces: type: integer maximum: 2147483647 minimum: 0 description: Number of bounced emails in the campaign. campaign_paused: type: boolean description: Indicates whether the campaign is paused. campaign_paused_on: type: - string - 'null' format: date-time description: Datetime when the campaign was paused. is_generating_schedules: type: boolean description: Indicates if schedules are being generated for the campaign. is_deleting_schedules: type: boolean description: Indicates if schedules are being deleted for the campaign. archived: type: boolean description: Flag indicating if the campaign is archived. is_campaign_bounce_blocked: type: boolean description: Flag indicating if the campaign is bounce-blocked. started_running_at: type: - string - 'null' format: date-time description: >- Datetime when the campaign started running. ISO format date string in UTC timezone. completed_at: type: - string - 'null' format: date-time description: >- Datetime when the campaign was completed. ISO format date string in UTC timezone. cancelled_at: type: - string - 'null' format: date-time description: >- Datetime when the campaign was cancelled. ISO format date string in UTC timezone. selected_contact_lists: type: array items: type: object additionalProperties: {} readOnly: true required: - created_on - selected_contact_lists - settings - uid - workspace_id SimpleMessageResponse: type: object properties: message: type: string required: - message CampaignSettings: type: object properties: name: type: string description: The name of the email campaign. maxLength: 300 reply_to_address: type: - string - 'null' description: Email address to which replies will be directed. maxLength: 254 daily_email_limit: type: integer maximum: 2147483647 minimum: 0 description: Daily emails per domain for this campaign. skip_days: type: array items: $ref: '#/components/schemas/SkipDaysEnum' description: >- Days on which emails will not be sent. Maximum 6 days can be skipped. At least one day should be available for sending emails. readOnly: true single_subject: type: boolean description: >- Indicates if all messages in the campaign have the same subject line. scheduling_strategy: allOf: - $ref: '#/components/schemas/CampaignSettingsSchedulingStrategyEnum' description: |- Strategy for scheduling the email campaign. * `testing` - Test Mode * `sequential` - Sequential Mode * `no-followup-limit` - No Followup Limit Mode * `smart-queue` - Smart Queue Mode * `single-message` - Single Message Mode from_time: type: - string - 'null' format: time description: 'Start of the daily time window to send emails. Format: HH:MM:SS.' to_time: type: - string - 'null' format: time description: 'End of the daily time window to send emails. Format: HH:MM:SS.' time_zone: type: - string - 'null' description: Time zone for the email sending schedule. maxLength: 100 add_unsub_link: type: boolean description: Flag to determine if an unsubscribe link should be added. unsub_link_type: type: string description: Type of unsubscribe link used ('custom' or 'auto'). maxLength: 100 custom_unsub_text: type: string description: Custom text for the unsubscribe link. one_click_unsubscribe_header: type: boolean description: Flag to send the List-Unsubscribe one-click unsubscribe headers. click_tracking_enabled: type: boolean description: Flag to enable tracking of email link clicks. open_tracking_enabled: type: boolean description: Flag to enable tracking of email opens. skip_dangerous_emails: type: boolean description: Flag to skip emails from potentially dangerous domains. skip_disposable_emails: type: boolean description: Flag to skip emails from disposable email providers. skip_catchall_emails: type: boolean description: Flag to skip catch-all email addresses. skip_full_inbox_emails: type: boolean description: Flag to skip emails from addresses with full inboxes. skip_invalid_emails: type: boolean description: Flag to skip invalid email addresses. skip_unverifiable_emails: type: boolean description: >- Flag to skip unverifiable email addresses (greylisted or connection timed out). forward_negative_emails: type: boolean description: Always forward Negative replies. forward_netural_emails: type: boolean description: Always forward Neutral replies. sending_domains: type: array items: type: integer description: List of domain IDs used for sending campaign emails. readOnly: true required: - name - sending_domains - skip_days StatusF69Enum: enum: - creating - created - scheduled - running - paused - complete - cancelled - failed type: string description: |- * `creating` - Creating * `created` - Created * `scheduled` - Scheduled * `running` - Running * `paused` - Paused * `complete` - Complete * `cancelled` - Cancelled * `failed` - Failed SkipDaysEnum: enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday type: string CampaignSettingsSchedulingStrategyEnum: enum: - testing - sequential - no-followup-limit - smart-queue - single-message type: string description: |- * `testing` - Test Mode * `sequential` - Sequential Mode * `no-followup-limit` - No Followup Limit Mode * `smart-queue` - Smart Queue Mode * `single-message` - Single Message Mode securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-Api-Key description: >- Your API key. In the dashboard, go to Integrations and open Deliveryman API Keys to create one. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.