> ## Documentation Index > Fetch the complete documentation index at: https://docs.ouraicalling.com/llms.txt > Use this file to discover all available pages before exploring further. # List campaigns > **Required scope:** `campaigns:read` (keys without scope restrictions have full access). ## OpenAPI ````yaml /api-reference/openapi.json get /campaigns openapi: 3.1.0 info: title: OurAiCalling API version: 1.0.0 description: >- REST API for OurAiCalling. Authenticate with an API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a Bearer token. Every response uses a consistent envelope: `{ "data": ... , "meta": { ... } }` on success and `{ "error": { "code", "message" } }` on failure. List endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`; `meta.pagination.total` carries the total match count. Everything documented here is also exposed as MCP tools at `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using the same credentials and permission model. servers: - url: https://app.famulor.io/api/v1 description: Hosted platform. - url: https://{domain}/api/v1 description: White-label tenant domain — same paths, tenant branding. variables: domain: default: app.famulor.io description: Your white-label tenant domain. security: - bearerAuth: [] tags: - name: Account description: Self-inspection of the calling credential. - name: Migrations description: Preview and import data from supported legacy platforms. - name: Assistants description: Create and manage voice assistants. - name: Tools description: >- Reusable tools (HTTP APIs and external MCP servers) assistants can call mid-conversation. - name: Voices description: Browse the text-to-speech voice library. - name: Calls description: Start outbound calls and read call history, transcripts and recordings. - name: History description: Unified conversation history across calls, messaging and assistant emails. - name: Campaigns description: Outbound calling campaigns with a compliant power dialer. - name: Leads description: Manage Audience contacts across campaigns, channels and Call QA metrics. - name: Segments description: >- Saved, dynamic lead filters — reusable audience definitions used for Audience search and campaign lead assignment. - name: Suppression description: Cross-channel marketing opt-outs and active workspace suppression records. - name: Callbacks description: >- Scheduled callbacks booked by the Schedule callback tool across voice, chat, and email. - name: Phone Numbers description: Marketplace numbers and customer-provided numbers. - name: SIP Trunks description: Bring your own SIP provider and numbers. - name: Carrier Connections description: Connect a supported carrier account and import its existing phone numbers. - name: Knowledge Bases description: RAG knowledge bases and documents for assistants. - name: Settings description: Workspace-level settings such as caller-memory defaults. - name: Billing description: Balance and minutes ledger of the key owner. - name: Automations description: >- Native workspace automations — list, create, update, trigger. Plan gate: automation_platform. - name: Integrations description: >- Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google Calendar, Outlook, native booking engine). Assign them to assistants to provide availability and booking tools, plus provider-supported appointment lookup, cancellation, and rescheduling. - name: Bookings description: >- Native booking engine — event types with weekly availability, public booking pages at /book/{workspace}/{slug}, and the bookings they produce. - name: Dashboards description: >- Custom analytics dashboards, reusable widgets, and tenant-scoped performance analytics. Requires the custom_dashboards plan feature. - name: Catalog description: >- Read-only platform catalogs — available models, supported assistant languages, and prompt templates. - name: Simulations description: Assistant simulation tests (plan-gated). - name: Versions description: Assistant configuration version history. - name: Caller IDs description: Outbound caller ID verification. - name: Widgets description: Web widget connectors. - name: Messaging description: >- Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK). Includes conversation delay, inactivity end, and conversation-ended webhooks. - name: QA description: Cohort AI Quality Assurance runs over call transcripts. - name: White Label description: >- Manage the customers of your white-label workspace on their behalf — list, register, mint access tokens, log in, log out, and transfer credits. Available to reseller workspaces with white-label access, and to platform admins (scoped to direct platform customers). Requires `platform:read` / `platform:write`. - name: API Keys description: >- Self-service API keys for the calling workspace. A key can only mint further keys with a scope subset of its own. - name: SMS description: Outbound SMS from workspace phone numbers. paths: /campaigns: get: tags: - Campaigns summary: List campaigns description: >- **Required scope:** `campaigns:read` (keys without scope restrictions have full access). operationId: listCampaigns parameters: - name: status in: query schema: type: string enum: - draft - running - paused - completed - archived - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/offset' responses: '200': description: A page of campaigns. content: application/json: schema: type: object required: - data properties: data: type: array items: $ref: '#/components/schemas/Campaign' meta: type: object description: >- Response metadata. `pagination.total` is the total number of matching items (ignoring limit/offset). properties: pagination: type: object properties: limit: type: integer example: 50 offset: type: integer example: 0 total: type: integer example: 3 example: data: - id: ca1b2c3d-0000-4000-8000-000000000030 name: July outreach status: draft assistant_id: a1b2c3d4-0000-4000-8000-000000000001 concurrency: 3 retry_max: 2 retry_delay_minutes: 60 calling_windows: mon: - - '09:00' - '20:00' tue: - - '09:00' - '20:00' timezone: Europe/Berlin amd_enabled: true voicemail_action: hangup voicemail_message: null started_at: null completed_at: null created_at: '2026-07-01T08:00:00Z' updated_at: '2026-07-01T08:00:00Z' meta: pagination: limit: 50 offset: 0 total: 1 '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' components: parameters: limit: name: limit in: query schema: type: integer minimum: 1 maximum: 200 default: 50 description: Page size (1–200). offset: name: offset in: query schema: type: integer minimum: 0 default: 0 description: Number of items to skip. schemas: Campaign: type: object properties: id: type: string format: uuid name: type: string status: type: string enum: - draft - scheduled - running - paused - completed - archived channel: type: string enum: - phone_call - whatsapp_template - whatsapp_call - sms default: phone_call channel_config: type: object additionalProperties: true follow_up_config: type: object additionalProperties: true scheduled_start_at: type: - string - 'null' format: date-time assistant_id: type: - string - 'null' format: uuid description: Assistant that runs the campaign calls. concurrency: type: integer minimum: 1 maximum: 10 description: >- Max parallel campaign calls (1–10). Effective slots also respect plan max_parallel_calls. retry_max: type: integer description: Max retry attempts per lead. retry_delay_minutes: type: integer calling_windows: $ref: '#/components/schemas/CallingWindows' timezone: type: string description: IANA timezone the calling windows are evaluated in. amd_enabled: type: boolean description: Answering-machine detection at call start. voicemail_action: type: string enum: - hangup - drop_message voicemail_message: type: - string - 'null' description: >- TTS text spoken to voicemail when `voicemail_action` is `drop_message`. started_at: type: - string - 'null' format: date-time completed_at: type: - string - 'null' format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time required: - id - name - status - created_at - updated_at CallingWindows: type: object description: >- Allowed calling windows per weekday, local to the campaign `timezone`. Keys: `mon`–`sun`; each value is an array of `["HH:MM", "HH:MM"]` start/end pairs (24h). An empty array or missing key blocks the whole day. propertyNames: enum: - mon - tue - wed - thu - fri - sat - sun additionalProperties: type: array items: type: array items: type: string pattern: ^([01][0-9]|2[0-3]):[0-5][0-9]$ minItems: 2 maxItems: 2 ErrorEnvelope: type: object description: Error envelope returned by every /api/v1 endpoint on failure. required: - error properties: error: type: object required: - code - message properties: code: type: string enum: - unauthorized - forbidden - not_found - invalid_request - rate_limited - conflict - telephony_configuration_error - telephony_unavailable - internal_error description: Stable, machine-readable error code. message: type: string description: Human-readable description of the error. responses: Unauthorized: description: Missing, invalid, expired or revoked API key / access token. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: unauthorized message: Invalid API key. Forbidden: description: >- The API key lacks the required scope, or the plan does not allow this action. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: error: code: forbidden message: This API key is missing the required scope "assistants:write". securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`). Keys can be restricted to scopes such as `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`, `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`, `phone_numbers:write`, `sip_trunks:write`, `knowledge:write`, `voices:read`, `billing:read`, `settings:write`, `platform:read`, `platform:write`; a `*:write` scope implies the matching `*:read`. Automation and dashboard endpoints also accept the legacy `calls:*` scope. Keys without scope restrictions have full access. ````