> ## Documentation Index > Fetch the complete documentation index at: https://docs.apostra.com/llms.txt > Use this file to discover all available pages before exploring further. # Get campaign workspace > Get the assembled `CampaignWorkspace` projection for the campaign drill-in widget: phase, handling, budget, source, plus media-buy and creative sections. A presentation-ready view over `get_campaign`, not a substitute for it. ## OpenAPI ````yaml /v2/buyer-api-v2.yaml get /campaigns/{campaignId}/workspace openapi: 3.0.0 info: title: Scope3 Buyer API version: 2.0.0 description: |- REST API for advertisers to manage advertisers, campaigns, and reporting. ## Authentication All endpoints require a Bearer token in the Authorization header: ``` Authorization: Bearer your-api-key ``` ## Base URL `https://api.interchange.io/api/v2/buyer` ## For AI Agents AI agents can use the MCP endpoint at `/mcp/v2/buyer` with three tools: - `initialize`: Start an MCP session - `api_call`: Make REST API calls - `ask_about_capability`: Learn about API features servers: - url: https://api.interchange.io/api/v2/buyer description: Production server security: [] tags: - name: Signup description: Request reviewed access to Interchange - name: Account description: Account management, service tokens, and preferences - name: Asks description: >- What you are waiting on Scope3 for — support, product, and supply asks in one list - name: Advertisers description: Manage advertisers - name: Product Discovery description: Discover and select products - name: Campaigns description: Manage advertising campaigns - name: Creatives description: Build, manage, and sync campaign creatives via AdCP Creative Protocol - name: Reporting description: Access performance metrics - name: Event Sources description: >- Manage event source configurations and log conversion/marketing events for attribution - name: Property Lists description: Validate property lists against AAO registry - name: Sales Agents description: View and connect sales agents - name: Measurement description: Measurement sources, records, context, and freshness - name: Syndication description: Syndicate resources to ADCP agents - name: Tasks description: Track async operation status - name: Buyer Billing description: >- Consolidated invoicing for buyers — invoices and pending invoice items issued by Scope3 across the buyer customer. - name: MCP description: Model Context Protocol endpoints for AI agents paths: /campaigns/{campaignId}/workspace: get: tags: - Campaigns summary: Get campaign workspace description: >- Get the assembled `CampaignWorkspace` projection for the campaign drill-in widget: phase, handling, budget, source, plus media-buy and creative sections. A presentation-ready view over `get_campaign`, not a substitute for it. operationId: getCampaignWorkspace parameters: - in: path name: campaignId schema: type: string minLength: 1 description: Unique identifier for the campaign example: cmp_987654321 required: true description: Unique identifier for the campaign responses: '200': description: Get campaign workspace content: application/json: schema: type: object properties: campaignId: type: string advertiserId: nullable: true type: string name: type: string revision: type: integer minimum: -9007199254740991 maximum: 9007199254740991 brief: type: string handling: type: string enum: - tracking - managing phase: type: string enum: - draft - active - completed - canceled mode: type: string enum: - review - record isPaused: type: boolean isArchived: type: boolean autonomy: type: object properties: inventorySelection: type: object properties: mode: type: string enum: - manual - propose - automatic source: type: string enum: - inherited - overridden required: - mode - source additionalProperties: false rebriefing: type: object properties: mode: type: string enum: - manual - propose - automatic source: type: string enum: - inherited - overridden required: - mode - source additionalProperties: false required: - inventorySelection - rebriefing additionalProperties: false flight: type: object properties: startAt: type: string endAt: type: string required: - startAt - endAt additionalProperties: false budget: type: object properties: total: type: number currency: type: string dailyCap: type: number pacing: type: string enum: - even - asap - frontloaded required: - total - currency additionalProperties: false source: type: object properties: kind: type: string enum: - interchange - connected_account - adcp sellerId: type: string freshness: type: string enum: - live - stale - error lastSyncedAt: type: string required: - kind additionalProperties: false sellerIds: type: array items: type: string createdAt: type: string updatedAt: type: string readiness: type: object properties: status: type: string enum: - ready - not_ready reasons: type: array items: type: string enum: - no_budget - no_staged_buys - flight_not_started - flight_ended - advertiser_missing attention: type: array items: type: string enum: - blocked - off_goal - drifted - stale nextAction: type: object properties: action: type: string label: type: string params: type: object additionalProperties: {} required: - action - label additionalProperties: false blockers: type: array items: type: object properties: code: type: string message: type: string required: - code - message additionalProperties: false required: - attention - blockers additionalProperties: false spend: oneOf: - type: object properties: state: type: string enum: - available value: type: object properties: total: type: number currency: type: string required: - total - currency additionalProperties: false asOf: type: string source: type: string required: - state - value - source additionalProperties: false - type: object properties: state: type: string enum: - pending reason: type: string retryAfterMs: type: number required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - unavailable reason: type: string required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - stale value: type: object properties: total: type: number currency: type: string required: - total - currency additionalProperties: false asOf: type: string source: type: string reason: type: string required: - state - value - asOf - source - reason additionalProperties: false type: object pacing: oneOf: - type: object properties: state: type: string enum: - available value: type: object properties: percent: type: number verdict: type: string enum: - behind - on_track - ahead required: - percent - verdict additionalProperties: false asOf: type: string source: type: string required: - state - value - source additionalProperties: false - type: object properties: state: type: string enum: - pending reason: type: string retryAfterMs: type: number required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - unavailable reason: type: string required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - stale value: type: object properties: percent: type: number verdict: type: string enum: - behind - on_track - ahead required: - percent - verdict additionalProperties: false asOf: type: string source: type: string reason: type: string required: - state - value - asOf - source - reason additionalProperties: false type: object outcome: oneOf: - type: object properties: state: type: string enum: - available value: type: object properties: label: type: string actual: type: number target: type: number unit: type: string verdict: type: string enum: - working - off_goal - neutral required: - label - actual - unit - verdict additionalProperties: false asOf: type: string source: type: string required: - state - value - source additionalProperties: false - type: object properties: state: type: string enum: - pending reason: type: string retryAfterMs: type: number required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - unavailable reason: type: string required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - stale value: type: object properties: label: type: string actual: type: number target: type: number unit: type: string verdict: type: string enum: - working - off_goal - neutral required: - label - actual - unit - verdict additionalProperties: false asOf: type: string source: type: string reason: type: string required: - state - value - asOf - source - reason additionalProperties: false type: object mediaBuys: type: array items: type: object properties: mediaBuyId: type: string sellerId: type: string sellerName: type: string name: type: string channelGroup: type: object properties: channelGroupId: type: string name: type: string required: - channelGroupId - name additionalProperties: false phase: type: string enum: - draft - pendingApproval - inputRequired - active - completed - canceled - failed - rejected isPaused: type: boolean budget: type: object properties: total: type: number currency: type: string required: - total - currency additionalProperties: false flight: type: object properties: startAt: type: string endAt: type: string required: - startAt - endAt additionalProperties: false spend: oneOf: - type: object properties: state: type: string enum: - available value: type: object properties: total: type: number currency: type: string required: - total - currency additionalProperties: false asOf: type: string source: type: string required: - state - value - source additionalProperties: false - type: object properties: state: type: string enum: - pending reason: type: string retryAfterMs: type: number required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - unavailable reason: type: string required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - stale value: type: object properties: total: type: number currency: type: string required: - total - currency additionalProperties: false asOf: type: string source: type: string reason: type: string required: - state - value - asOf - source - reason additionalProperties: false type: object delivery: oneOf: - type: object properties: state: type: string enum: - available value: type: object properties: percent: type: number required: - percent additionalProperties: false asOf: type: string source: type: string required: - state - value - source additionalProperties: false - type: object properties: state: type: string enum: - pending reason: type: string retryAfterMs: type: number required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - unavailable reason: type: string required: - state - reason additionalProperties: false - type: object properties: state: type: string enum: - stale value: type: object properties: percent: type: number required: - percent additionalProperties: false asOf: type: string source: type: string reason: type: string required: - state - value - asOf - source - reason additionalProperties: false type: object proposalSource: type: object properties: proposalId: type: string version: type: integer minimum: -9007199254740991 maximum: 9007199254740991 state: type: string enum: - quoted - bound - expired - withdrawn required: - proposalId - version additionalProperties: false source: type: object properties: freshness: type: string enum: - live - stale - error lastSyncedAt: type: string additionalProperties: false attentionNote: type: string required: - mediaBuyId - sellerId - name - phase - isPaused - budget - spend additionalProperties: false creatives: type: array items: type: object properties: creativeId: type: string name: type: string formatLabel: type: string dimensions: type: string previewUrl: type: string readiness: type: string enum: - ready - missing - in_review - rejected sellerReviews: type: array items: type: object properties: sellerName: type: string status: type: string enum: - ready - missing - in_review - rejected issue: type: string required: - sellerName - status additionalProperties: false placements: type: array items: type: object properties: placementId: type: string placementName: type: string required: - placementId - placementName additionalProperties: false required: - creativeId - name additionalProperties: false recentActivity: type: array items: type: object properties: id: type: string at: type: string actor: type: string enum: - person - agent - automation - system summary: type: string outcome: type: string enum: - success - denied - failed required: - id - at - actor - summary additionalProperties: false targeting: type: object properties: geo: description: >- Geographic targeting requirements (countries and regions). type: array items: type: object properties: requirementId: type: string minLength: 1 description: >- Stable identifier for this requirement; unique across all targeting dimensions. strength: type: string enum: - required - preferred description: >- "required" means must satisfy; "preferred" means optimize toward. include: description: >- ISO 3166-1 alpha-2 country codes or CLDR region subdivisions to include. minItems: 1 type: array items: type: string pattern: ^[A-Z]{2}(-[A-Z0-9]{1,8})?$ exclude: description: >- ISO 3166-1 alpha-2 country codes or CLDR region subdivisions to exclude. minItems: 1 type: array items: type: string pattern: ^[A-Z]{2}(-[A-Z0-9]{1,8})?$ required: - requirementId - strength additionalProperties: false language: description: Language targeting requirements (BCP 47 tags). type: array items: type: object properties: requirementId: type: string minLength: 1 description: >- Stable identifier for this requirement; unique across all targeting dimensions. strength: type: string enum: - required - preferred description: >- "required" means must satisfy; "preferred" means optimize toward. include: description: >- BCP 47 language tags to include (e.g. "en", "en-US"). minItems: 1 type: array items: type: string pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$ exclude: description: BCP 47 language tags to exclude. minItems: 1 type: array items: type: string pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$ required: - requirementId - strength additionalProperties: false device: description: Device-type targeting requirements. type: array items: type: object properties: requirementId: type: string minLength: 1 description: >- Stable identifier for this requirement; unique across all targeting dimensions. strength: type: string enum: - required - preferred description: >- "required" means must satisfy; "preferred" means optimize toward. include: description: >- AdCP device types to include: desktop, mobile, tablet, ctv, dooh, unknown. minItems: 1 type: array items: type: string enum: - desktop - mobile - tablet - ctv - dooh - unknown exclude: description: AdCP device types to exclude. minItems: 1 type: array items: type: string enum: - desktop - mobile - tablet - ctv - dooh - unknown required: - requirementId - strength additionalProperties: false dayparts: description: >- Daypart targeting requirements (time windows per timezone). type: array items: type: object properties: requirementId: type: string minLength: 1 description: >- Stable identifier for this requirement; unique across all targeting dimensions. strength: type: string enum: - required - preferred description: >- "required" means must satisfy; "preferred" means optimize toward. timezone: type: string minLength: 1 description: >- IANA tzdata identifier (e.g. "America/New_York"). windows: minItems: 1 type: array items: type: object properties: days: minItems: 1 type: array items: type: string enum: - mon - tue - wed - thu - fri - sat - sun description: Days of the week this window applies to. startHour: type: integer minimum: 0 maximum: 23 description: >- Window start in 24-hour local time, inclusive (0-23). endHour: type: integer minimum: 1 maximum: 24 description: >- Window end in 24-hour local time, exclusive (1-24); 24 means end-of-day. required: - days - startHour - endHour additionalProperties: false description: >- One or more time windows; delivery is in-scope if it falls inside any window. required: - requirementId - strength - timezone - windows additionalProperties: false demographics: description: Demographic targeting requirements. type: object properties: age: description: Age targeting requirements. type: array items: type: object properties: requirementId: type: string minLength: 1 description: >- Stable identifier for this requirement; unique across all targeting dimensions. strength: type: string enum: - required - preferred description: >- "required" means must satisfy; "preferred" means optimize toward. minAge: description: Inclusive lower age bound (integer years). type: integer minimum: 0 maximum: 9007199254740991 maxAge: description: Inclusive upper age bound (integer years). type: integer minimum: 0 maximum: 9007199254740991 includeUnknownAge: default: false description: >- Include users whose age cannot be determined. Defaults to false. type: boolean allowModeledAge: default: false description: >- Accept statistically modeled age when verified signal is unavailable. Defaults to false. type: boolean required: - requirementId - strength - includeUnknownAge - allowModeledAge additionalProperties: false additionalProperties: false additionalProperties: false channelGroups: minItems: 1 maxItems: 25 type: array items: type: object properties: channelGroupId: type: string minLength: 1 maxLength: 128 name: type: string minLength: 1 maxLength: 120 source: oneOf: - type: object properties: kind: type: string enum: - preset presetId: type: string enum: - display - olv - mobile_web_display - mobile_web_olv - ctv description: >- Versioned channel group preset to expand into AdCP inventory dimensions. presetVersion: type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - kind - presetId - presetVersion additionalProperties: false - type: object properties: kind: type: string enum: - custom required: - kind additionalProperties: false type: object inventory: type: object properties: channels: description: >- Buyer-declared AdCP media channels. Values are OR. minItems: 1 type: array items: type: string enum: - display - olv - social - search - ctv - linear_tv - radio - streaming_audio - podcast - dooh - ooh - print - cinema - email - gaming - retail_media - influencer - affiliate - product_placement - sponsored_intelligence propertyTypes: description: >- Buyer-declared AdCP property types. Values are OR. minItems: 1 type: array items: type: string enum: - website - mobile_app - ctv_app - desktop_app - dooh - podcast - radio - linear_tv - streaming_audio - ai_assistant deviceTypes: description: Buyer-declared AdCP device types. Values are OR. minItems: 1 type: array items: type: string enum: - desktop - mobile - tablet - ctv - dooh - unknown formatKinds: description: >- Buyer-declared AdCP canonical creative format kinds. Values are OR. minItems: 1 type: array items: type: string enum: - image - html5 - display_tag - image_carousel - video_hosted - video_vast - audio_hosted - audio_vast - audio_daast - sponsored_placement - native_in_feed - responsive_creative - agent_placement - seller_rendered_stateful_display - coordinated_placements - custom additionalProperties: false required: - channelGroupId - name - source - inventory additionalProperties: false required: - campaignId - advertiserId - name - revision - handling - phase - isPaused - isArchived - autonomy - createdAt - updatedAt additionalProperties: false '400': description: Bad request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] components: schemas: ErrorResponse: type: object properties: data: type: string nullable: true enum: - null error: $ref: '#/components/schemas/ApiError' required: - data - error additionalProperties: false description: Standard error response ApiError: type: object properties: code: type: string description: Machine-readable error code message: type: string description: Human-readable error message field: description: Field path associated with the error type: string details: description: Additional error context type: object additionalProperties: {} required: - code - message additionalProperties: false description: Structured error object securitySchemes: bearerAuth: type: http scheme: bearer description: API key or access token ````