> ## Documentation Index > Fetch the complete documentation index at: https://doc.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # List campaign summaries > Returns lightweight read-only summaries of campaigns, including id, name, state, and dates. Supports filtering via query parameters. ## OpenAPI ````yaml /api-reference/management.json get /v2/campaign-summaries openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Blocks - name: Campaigns - name: Components - name: Components Settings - name: Domains - name: Email - name: Erasure - name: Event Streams - name: File Validation Monitors - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v2/campaign-summaries: get: tags: - Campaigns summary: List campaign summaries description: >- Returns lightweight read-only summaries of campaigns, including id, name, state, and dates. Supports filtering via query parameters. operationId: listCampaignSummaries parameters: - in: query name: version schema: type: string - in: query name: program_type schema: type: string - in: query name: tags schema: items: type: string type: array uniqueItems: true - in: query name: labels schema: items: type: string type: array uniqueItems: true - in: query name: program_label schema: type: string - in: query name: states schema: items: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string type: array uniqueItems: true - in: query name: include_archived schema: type: boolean responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CampaignSummaryResponse' type: array description: Successful response '400': content: application/json: examples: binding_error: $ref: '#/components/examples/binding_error' campaign_concurrent_update: $ref: '#/components/examples/campaign_concurrent_update' campaign_has_pending_changes: $ref: '#/components/examples/campaign_has_pending_changes' campaign_locked: $ref: '#/components/examples/campaign_locked' campaign_version_malformed: $ref: '#/components/examples/campaign_version_malformed' date_invalid: $ref: '#/components/examples/date_invalid' invalid_campaign_id: $ref: '#/components/examples/invalid_campaign_id' invalid_campaign_state: $ref: '#/components/examples/invalid_campaign_state' invalid_campaign_version: $ref: '#/components/examples/invalid_campaign_version' invalid_json: $ref: '#/components/examples/invalid_json' invalid_parameter: $ref: '#/components/examples/invalid_parameter' lock_missing_lock_types: $ref: '#/components/examples/lock_missing_lock_types' missing_request_body: $ref: '#/components/examples/missing_request_body' unlock_missing_lock_types: $ref: '#/components/examples/unlock_missing_lock_types' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Bad Request '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: CampaignSummaryResponse: properties: campaign_id: type: string campaign_locks: items: enum: - DUPLICATE - EDIT type: string type: array campaign_type: enum: - CONFIGURATION - EXTENSION - INTEGRATION - MARKETING type: string description: type: string end_date: $ref: '#/components/schemas/ZonedDateTime' is_published: type: boolean labels: items: $ref: '#/components/schemas/CampaignLabelResponse' type: array last_published_date: $ref: '#/components/schemas/ZonedDateTime' name: type: string pause_date: $ref: '#/components/schemas/ZonedDateTime' program_label: type: string program_type: type: string root_component_type: type: string start_date: $ref: '#/components/schemas/ZonedDateTime' state: enum: - ARCHIVED - ENDED - LIVE - NOT_LAUNCHED - PAUSED - STOPPED type: string stop_date: $ref: '#/components/schemas/ZonedDateTime' tags: items: type: string type: array uniqueItems: true theme_name: type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' variants: items: type: string type: array required: - campaign_id - campaign_locks - campaign_type - description - end_date - is_published - labels - last_published_date - name - pause_date - program_label - program_type - root_component_type - start_date - state - stop_date - tags - theme_name - updated_date - variants type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object ZonedDateTime: description: >- [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. example: '2025-10-24T02:00:00-07:00' pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string CampaignLabelResponse: properties: name: type: string type: enum: - DATA - PROGRAM type: string type: object examples: binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_concurrent_update: summary: campaign_concurrent_update value: code: campaign_concurrent_update http_status_code: 400 message: >- Could not perform the operation. Campaign is currently updated by other process/user parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_has_pending_changes: summary: campaign_has_pending_changes value: code: campaign_has_pending_changes http_status_code: 400 message: Could not perform the operation. Campaign has pending changes parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_locked: summary: campaign_locked value: code: campaign_locked http_status_code: 400 message: Could not perform the operation. The campaign is locked parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 campaign_version_malformed: summary: campaign_version_malformed value: code: campaign_version_malformed http_status_code: 400 message: Campaign version is malformed parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 date_invalid: summary: date_invalid value: code: date_invalid http_status_code: 400 message: Date is invalid or not ISO-8601 compliant parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_id: summary: invalid_campaign_id value: code: invalid_campaign_id http_status_code: 400 message: Invalid Campaign Id parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_state: summary: invalid_campaign_state value: code: invalid_campaign_state http_status_code: 400 message: Invalid campaign state parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_campaign_version: summary: invalid_campaign_version value: code: invalid_campaign_version http_status_code: 400 message: Invalid Campaign Version parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 lock_missing_lock_types: summary: lock_missing_lock_types value: code: lock_missing_lock_types http_status_code: 400 message: Unable to unlock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unlock_missing_lock_types: summary: unlock_missing_lock_types value: code: unlock_missing_lock_types http_status_code: 400 message: Unable to lock, lock types should be specified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````