Scope3 Interchange Buyer API
The buyer side of Scope3 Interchange, the Interchange for agent-to-agent advertising: 212 published operations covering advertisers, campaigns, product discovery, creatives, media buys, measurement, syndication, webhook subscriptions and buyer billing. Built for AI agents as primary callers — the same surface is reachable over REST or through a hosted remote MCP endpoint, and Scope3 publishes an Agent Skill for it.
Scope3 Interchange Buyer API is one of 16 APIs that Scope3 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Agentic, Advertising, AdTech, AdCP, and MCP. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 212 operations across 171 paths, organized into 27 resource areas, and defines 462 schemas. It is described by OpenAPI 3.0.0, at version 2.0.0.
Requests are made against a single base URL, https://api.interchange.io/api/v2/buyer.
212 operations
171 paths
462 schemas
19 DELETE93 GET8 PATCH79 POST13 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Scope3 Interchange Buyer API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
bearerAuth— API key or access token
Paths & Operations 212
Across 171 paths, the API surfaces 212 operations — 19 DELETE, 93 GET, 8 PATCH, 79 POST, 13 PUT. They span 27 resource areas, including Signup, Advertisers, Creatives, Brands, Product Discovery, Webhook Subscriptions, Campaigns, Audit Logs, and 19 more. Each is listed below with its method, path, parameters, and response codes.
Signup 1
Request reviewed access to Interchange
POST
/auth/buyer-signup-intake
Request buyer access
Advertisers 22
Manage advertisers
GET
/advertisers
List advertisers
POST
/advertisers
Create advertiser
GET
/all-advertisers-home
List all advertisers home
GET
/advertisers/{advertiserId}
Get advertiser
PUT
/advertisers/{advertiserId}
Update advertiser
DELETE
/advertisers/{advertiserId}
Delete advertiser
POST
/advertisers/{advertiserId}/restore
Restore advertiser
POST
/advertisers/{advertiserId}/data-delivery-credentials/{name}/validate
Revalidate data delivery credential
GET
/advertisers/{advertiserId}/accounts
List advertiser accounts
POST
/advertisers/{advertiserId}/accounts
Assign account
GET
/advertisers/{advertiserId}/accounts/{accountId}
Get advertiser account
GET
/advertisers/{advertiserId}/accounts/available
List available accounts
DELETE
/advertisers/{advertiserId}/accounts/{linkId}
Unmap a partner account from an advertiser
PUT
/advertisers/{advertiserId}/accounts/{linkId}/reporting-bucket
Update account reporting bucket
GET
/advertisers/{advertiserId}/catalogs
List catalogs
POST
/advertisers/{advertiserId}/catalogs/sync
Sync catalogs
PUT
/advertisers/{advertiserId}/catalogs/{catalogId}/transform
Save catalog transform
POST
/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/preview
Preview catalog activation plan
POST
/advertisers/{advertiserId}/catalogs/{catalogId}/refresh
Refresh catalog
POST
/advertisers/{advertiserId}/catalogs/{catalogId}/activation-plan/execute
Execute catalog activation plan
POST
/advertisers/{accountId}/audiences/sync
Sync audiences
GET
/advertisers/{accountId}/audiences
List audiences
Creatives 39
Build, manage, and sync campaign creatives via AdCP Creative Protocol
GET
/advertisers/{advertiserId}/creative/model-credentials
List generation-provider keys for an advertiser
POST
/advertisers/{advertiserId}/creative/model-credentials
Connect a generation-provider key for an advertiser
PATCH
/creative/model-credentials/{id}
Update or rotate a generation-provider key
GET
/creative-dashboard-url
Get creative dashboard URL
POST
/campaigns/{campaignId}/creatives/create
Create creative manifest
GET
/campaigns/{campaignId}/creatives/templates
List creative templates
GET
/campaigns/{campaignId}/creativeManifest
List creative manifests
GET
/campaigns/{campaignId}/creatives
List creatives
POST
/campaigns/{campaignId}/creatives/bulk-update
Bulk update creatives
POST
/advertisers/{advertiserId}/creatives/create
Create advertiser creative master
GET
/advertisers/{advertiserId}/creatives
List advertiser creative library
POST
/advertisers/{advertiserId}/creatives/save-to-library
Promote advertiser creatives into the library shelf
POST
/creatives/stash
Stash brought creatives before an advertiser is chosen
POST
/advertisers/{advertiserId}/creative-intent
Open the creative-intent picker for an advertiser
GET
/campaigns/{campaignId}/creative-confirmation
Get creative-confirmation card for a campaign
POST
/campaigns/{campaignId}/creative-confirmation
Attach brought creatives to a campaign
POST
/campaigns/{campaignId}/creatives/{creativeId}/placement
Reassign a brought creative to a different placement
POST
/campaigns/{campaignId}/creatives/placements
Batch-reassign brought creatives to placements
POST
/advertisers/{advertiserId}/creatives/{creativeId}/campaigns
Assign creative to campaign
DELETE
/advertisers/{advertiserId}/creatives/{creativeId}/campaigns/{campaignId}
Unassign creative from campaign
DELETE
/advertisers/{advertiserId}/creatives/{creativeId}
Archive creative globally
GET
/campaigns/{campaignId}/creative-collections
List creative collections
POST
/campaigns/{campaignId}/creative-collections
Create creative collection
GET
/campaigns/{campaignId}/creative-collections/{collectionId}
Get creative collection
PUT
/campaigns/{campaignId}/creative-collections/{collectionId}
Update creative collection
POST
/campaigns/{campaignId}/creative-collections/{collectionId}/members
Add creative collection members
DELETE
/campaigns/{campaignId}/creative-collections/{collectionId}/members
Remove creative collection members
POST
/campaigns/{campaignId}/creative-collections/{collectionId}/attach
Attach creative collection to campaign
GET
/advertisers/{advertiserId}/creative-collections
List advertiser creative collections
POST
/advertisers/{advertiserId}/creative-collections
Create advertiser creative collection
GET
/campaigns/{campaignId}/creatives/{creativeId}
Get creative manifest
PUT
/campaigns/{campaignId}/creatives/{creativeId}
Update creative manifest
DELETE
/campaigns/{campaignId}/creatives/{creativeId}
Delete creative manifest
POST
/campaigns/{campaignId}/creatives/{creativeId}/preview
Preview creative
POST
/campaigns/{campaignId}/creatives/{creativeId}/duplicate
Duplicate creative
GET
/campaigns/{campaignId}/creative-sessions/{sessionId}
Get creative session
POST
/campaigns/{campaignId}/creative-sessions/{sessionId}/evaluate
Evaluate creative session
POST
/campaigns/{campaignId}/creative-sessions/{sessionId}/finalize
Finalize creative session
GET
/campaigns/{campaignId}/creative-references
Get creative references
Brands 1
POST
/brands/resolve
Resolve a brand profile
Product Discovery 9
Discover and select products
POST
/products/query
Get products across storefronts
POST
/media-buys/batch
Stage or execute products across storefronts
POST
/discovery/discover-products
Discover products
GET
/discovery/{discoveryId}/discover-products
Browse products for discovery session
GET
/discovery/{discoveryId}/products/{productId}/details
Get product details
GET
/discovery/{discoveryId}/products
Get selected products
POST
/discovery/{discoveryId}/products
Add products to selection
DELETE
/discovery/{discoveryId}/products
Remove products from selection
POST
/discovery/{discoveryId}/apply-proposal
Apply a proposal
Webhook Subscriptions 3
POST
/webhook-subscriptions
Register a webhook subscription
GET
/webhook-subscriptions
List webhook subscriptions
DELETE
/webhook-subscriptions/{id}
Delete a webhook subscription
Campaigns 21
Manage advertising campaigns
GET
/campaigns
List campaigns
POST
/campaigns
Create campaign
PUT
/campaigns/{campaignId}
Update campaign
GET
/campaigns/{campaignId}
Get campaign
DELETE
/campaigns/{campaignId}
Delete campaign
GET
/campaigns/{campaignId}/delivery
Get campaign delivery (alpha)
POST
/campaigns/{campaignId}/execute
Execute campaign
POST
/campaigns/{campaignId}/pause
Pause campaign
POST
/campaigns/{campaignId}/reactivate
Reactivate campaign
POST
/campaigns/{campaignId}/auto-select-products
Auto-select products
GET
/campaigns/{campaignId}/media-buy-status
Get media buy ADCP status
GET
/media-buys/{mediaBuyId}
Get media buy
PATCH
/media-buys/{mediaBuyId}
Update media buy
GET
/media-buys/{mediaBuyId}/packages
List media buy packages
POST
/media-buys/{mediaBuyId}/pause
Pause media buy
POST
/media-buys/{mediaBuyId}/reactivate
Reactivate media buy
GET
/campaigns/{campaignId}/products
Get campaign products
GET
/targeting/dimensions
List targeting dimensions
GET
/targeting/dimensions/{system}
List targeting dimension values
GET
/targeting/dimensions/{system}/resolve
Resolve targeting dimension text
GET
/targeting/geo-metros
List geo metros
Audit Logs 1
GET
/audit-logs
List buyer audit logs
Activity 2
GET
/activity/calls
List API calls
GET
/activity/calls/{activityUid}
Get API call detail
Event Sources 3
Manage event source configurations and log conversion/marketing events for attribution
GET
/advertisers/{advertiserId}/event-sources
List event sources
POST
/advertisers/{advertiserId}/event-sources/sync
Sync event sources
POST
/advertisers/{advertiserId}/log-event
Log conversion events
Reporting 2
Access performance metrics
GET
/advertisers/{advertiserId}/events/summary
Get event summary
GET
/reporting/metrics
Get reporting
Measurement 16
Measurement sources, records, context, and freshness
POST
/advertisers/{advertiserId}/measurement-data/sync
Sync measurement data
GET
/advertisers/{advertiserId}/test-cohorts
List test cohorts
POST
/advertisers/{advertiserId}/test-cohorts
Create test cohort
GET
/advertisers/{advertiserId}/test-cohorts/{cohortId}
Get test cohort
PUT
/advertisers/{advertiserId}/test-cohorts/{cohortId}
Update test cohort
DELETE
/advertisers/{advertiserId}/test-cohorts/{cohortId}
Delete test cohort
GET
/advertisers/{advertiserId}/measurement-config
Get measurement configuration
PUT
/advertisers/{advertiserId}/measurement-config
Update measurement configuration
GET
/advertisers/{advertiserId}/measurement-sources
List measurement sources
POST
/advertisers/{advertiserId}/measurement-sources
Create measurement source
GET
/advertisers/{advertiserId}/measurement-sources/{sourceId}
Get measurement source
PATCH
/advertisers/{advertiserId}/measurement-sources/{sourceId}
Update measurement source
POST
/advertisers/{advertiserId}/measurement-records
Upload measurement records
GET
/advertisers/{advertiserId}/measurement-records
List measurement records
POST
/advertisers/{advertiserId}/context-records
Upload context records
GET
/advertisers/{advertiserId}/measurement-freshness
Check measurement freshness
Optimization Suggestions 4
GET
/optimization-suggestions
List optimization suggestions
GET
/optimization-suggestions/{suggestionId}
Get optimization suggestion
POST
/optimization-suggestions/{suggestionId}/approve
Approve optimization suggestion
POST
/optimization-suggestions/{suggestionId}/reject
Reject optimization suggestion
Asks 1
What you are waiting on Scope3 for — support, product, and supply asks in one list
GET
/asks
List my asks
Supply Requests 4
GET
/supply-requests/suggestions
Suggest requested supply
GET
/supply-requests
List requested supply
POST
/supply-requests
Request supply
POST
/supply-requests/remove
Remove requested supply
Account 17
Account management, service tokens, and preferences
GET
/accounts/current
Get current account
GET
/accounts
List customer accounts
POST
/accounts/create-child
Create child account
PATCH
/accounts/{customerId}/domain
Update customer domain
DELETE
/accounts/{customerId}
Delete child account
GET
/accounts/{customerId}/membership
Get membership settings
PATCH
/accounts/{customerId}/membership
Update membership settings
GET
/browser-origins
List browser origins
POST
/browser-origins
Register browser origin
DELETE
/browser-origins/{id}
Delete browser origin
GET
/notification-preferences
Get notification preferences
PUT
/notification-preferences
Update notification preferences
GET
/notification-delivery-preferences
Get Slack notification settings
PUT
/notification-delivery-preferences
Update a Slack notification setting
POST
/market-readiness
Preview market readiness
GET
/readiness
Get buyer readiness
PATCH
/readiness/operator
Update buyer operator domain
Notifications 4
GET
/notifications
List notifications
POST
/notifications/read-all
Mark all notifications as read
POST
/notifications/{notificationId}/read
Mark notification as read
POST
/notifications/{notificationId}/acknowledge
Acknowledge notification
Release Updates 2
GET
/release-updates
List personalized release updates
POST
/release-updates/seen
Mark release updates as seen
Moderation 1
POST
/moderation/check
Pre-check content against moderation policy
Storefronts 19
GET
/storefronts
List storefronts
GET
/storefronts/{storefrontId}
Get storefront
GET
/storefronts/{storefrontId}/capabilities
Get storefront capabilities
GET
/storefront-connections
List storefront connections
GET
/storefront-connection-account-mappings
List external account mappings
GET
/storefront-connections/{connectionId}/accounts
List integration external accounts
DELETE
/storefront-connections/{connectionId}
Remove storefront connection
PATCH
/storefront-connections/{connectionId}/accounts/{accountId}/select
Select integration external account
POST
/storefront-connections/{connectionId}/accounts/{accountId}/advertiser
Map external account to advertiser
POST
/storefront-connections/{connectionId}/accounts/{accountId}/directed-campaigns/subscribe
Subscribe a directed-campaign account (alpha)
GET
/storefront-connections/{connectionId}/accounts/{accountId}/directed-campaigns/subscription
Get directed-campaign subscription health (alpha)
DELETE
/storefront-connections/{connectionId}/accounts/{accountId}/directed-campaigns/subscription
Unsubscribe a directed-campaign account (alpha)
GET
/storefront-connections/{connectionId}/accounts/{accountId}/presences
List account presences (alpha)
PATCH
/storefronts/{storefrontId}/connection-policy
Update storefront connection policy
POST
/storefronts/{storefrontId}/connection
Connect storefront
GET
/storefronts/credentials
List credentials
POST
/storefronts/{storefrontId}/sources/{sourceId}/credentials
Register source credentials
POST
/storefronts/{storefrontId}/sources/{sourceId}/adcp-connection
Connect a registered AdCP source (alpha)
GET
/storefronts/{storefrontId}/publishers
List publisher domains for a storefront
Syndication 2
Syndicate resources to ADCP agents
POST
/advertisers/{advertiserId}/syndicate
Toggle syndication for a resource
GET
/advertisers/{advertiserId}/syndication-status
Query syndication status
Tasks 1
Track async operation status
GET
/tasks/{taskId}
Get task status
Property Lists 9
Validate property lists against AAO registry
GET
/advertisers/{advertiserId}/property-lists
List property lists
POST
/advertisers/{advertiserId}/property-lists
Create property list
GET
/advertisers/{advertiserId}/property-lists/{listId}
Get property list
PUT
/advertisers/{advertiserId}/property-lists/{listId}
Update property list
DELETE
/advertisers/{advertiserId}/property-lists/{listId}
Delete property list
GET
/campaigns/{campaignId}/property-lists
Get campaign property lists
POST
/campaigns/{campaignId}/property-lists
Attach property list to campaign
POST
/property-lists/check
Check property list
GET
/property-lists/reports/{reportId}
Get property list check report
Buyer Billing 15
Consolidated invoicing for buyers — invoices and pending invoice items issued by Scope3 across the buyer customer.
GET
/billing/info
Get billing information
PUT
/billing/info
Update billing information (admin)
GET
/billing/account
Get billing account
GET
/billing/iu-rate-card
Get the organization IU Rate Card offer and acceptance state
GET
/billing/iu-rate-card/v2
Get the versioned organization IU commercial document
GET
/billing/iu-rate-card/document.pdf
Download the current Commercial Offer proposal
POST
/billing/iu-rate-card/accept
Accept an exact organization IU Rate Card offer
POST
/billing/payment-methods/setup
Start adding a card (admin)
GET
/billing/payment-methods
List payment methods
DELETE
/billing/payment-methods/{id}
Remove a payment method (admin)
GET
/capture-links/{token}
Open a payment capture link
POST
/billing/payment-methods/pay-now
Manually retry the outstanding failed charge (admin)
GET
/billing/invoice-activity
Get invoice activity
GET
/billing/fee-invoices
List fee invoices
GET
/billing/fee-invoices/{invoiceNumber}
Get fee invoice
Media Billing 8
GET
/billing/media-entities
List media billing entities
POST
/billing/media-entities
Create media billing entity (admin)
PUT
/billing/media-entities/{entityId}
Update media billing entity (admin)
DELETE
/billing/media-entities/{entityId}
Delete media billing entity (admin)
GET
/billing/media-entities/attachments
List media billing attachments
POST
/billing/media-entities/attachments
Attach media billing entity (admin)
DELETE
/billing/media-entities/attachments/{attachmentId}
Delete media billing attachment (admin)
GET
/billing/media-entities/resolve
Resolve media billing entity
Update Proposals 2
GET
/update-proposals/{id}
Get update proposal status
DELETE
/update-proposals/{id}
Cancel a pending update proposal
MCP 3
Model Context Protocol endpoints for AI agents
POST
/
Initialize MCP session
POST
/api-call
Make API call via MCP
POST
/ask-about-capability
Ask about API capabilities
Schemas 462
The contract defines 462 schemas that model the data the API accepts and returns. The most detailed are ActivityCall (50 properties), InterchangeProduct (49 properties), Campaign (31 properties), CreativeManifestResponse (31 properties). Each schema is shown below with its type and property counts.
CreateAdvertiserBody
object
Request body for creating a new advertiser
11 properties
3 required
LinkedAccountInput
object
An account to link to the advertiser
5 properties
3 required
OptimizationApplyMode
string
Whether optimization suggestions are automatically applied or require human approval.
AdvertiserDataDeliveryInput
object
Data-delivery configuration for this advertiser. Groups standing Data Delivery Outputs and the credentials they reference. Distinct from media-buy reporting fi…
2 properties
DataDeliveryCredentialArrayInput
array
Array of Data Delivery Credentials for one advertiser. Names must be unique within the array.
DataDeliveryCredentialInput
object
A single Data Delivery Credential entry. Used inline on advertiser create+update; full-replace by name within one request.
2 properties
2 required
CredentialConfigInput
object
Destination-specific auth target as submitted by the buyer. AZUREBLOB carries the SAS token; the API persists it to Google Secret Manager and stores only a ref…
GcsCredentialConfig
object
2 properties
2 required
S3CredentialConfig
object
3 properties
3 required
AzureBlobCredentialConfigInput
object
4 properties
4 required
AzureBlobAuthInput
object
How Scope3 authenticates to the buyer-owned Azure Blob container. SASTOKEN uses a container-scoped Shared Access Signature.
AzureBlobSasAuthInput
object
2 properties
2 required
DataDeliveryOutputArrayInput
array
Array of Data Delivery Outputs for one scope (advertiser or campaign). At most one Output per (dataDeliveryType, credentialName) pair — the same data type can…
DataDeliveryOutputInput
object
A single Data Delivery Output entry. Used inline on advertiser/campaign create+update.
6 properties
4 required
DeliveryConfig
object
Per-Output destination shape (non-secret). Additional destination types are added as new variants in this discriminated union.
GcsDeliveryConfig
object
3 properties
1 required
S3DeliveryConfig
object
3 properties
1 required
AzureBlobDeliveryConfig
object
3 properties
1 required
FrequencyCapConfigInput
object
Frequency cap entry supplied inside a parent advertiser/campaign/creative request body. On PUT, the full array replaces all existing caps for that target.
2 properties
2 required
FrequencyCapWindow
object
Rolling time window over which maximpressions applies (AdCP Duration shape).
2 properties
2 required
UpdateAdvertiserBody
object
Request body for updating an advertiser
10 properties
ConnectBuyerModelCredentialBody
object
3 properties
3 required
ResolveBrandBody
object
1 property
1 required
GetProductsBody
object
Canonical AdCP getproducts request with optional Interchange multi-storefront and buyer-intelligence controls.
20 properties
1 required
ProposalEvaluationRequest
object
Managed buyer operating instructions for proposal disposition, optional enrichment, bounded refinement, and optional comparative ranking. This is prompt config…
5 properties
1 required
ProposalScreeningRequest
object
Deprecated compatibility alias for managed proposal evaluation. It enables accept, reject, or refine without enrichment or comparative ranking.
3 properties
1 required
CreateMediaBuysBatchBody
object
Stage or execute multiple storefront-qualified getproducts selections through one DRAFT campaign cart.
6 properties
4 required
BatchMediaBuyCampaign
Use an existing campaign cart, or provide the complete fields for a new DRAFT discovery campaign.
CreateDiscoveryCampaignBody
object
Request body for creating a discovery-mode campaign
18 properties
5 required
PerformanceConfig
object
Configuration for performance campaign optimization
1 property
1 required
OptimizationGoal
object
A single optimization target. Either kind "event" (conversion events) or kind "metric" (seller-native delivery metric).
EventGoal
object
Optimize for advertiser-tracked conversion events via event sources.
5 properties
2 required
OptimizationAttributionWindow
object
Attribution window for conversion optimization
2 properties
1 required
Duration
object
A duration expressed as an interval and unit
2 properties
2 required
MetricGoal
object
Optimize for a seller-tracked delivery metric. No event source required.
5 properties
2 required
PacingPeriods
object
Defines a pacing schedule for a campaign. Periods represent time windows with varying spend intensity. Gaps between periods are treated as pauses (no spend). U…
2 properties
2 required
CampaignUtmConfig
object
UTM configuration for a campaign. Overrides advertiser-level defaults for matching param keys.
2 properties
1 required
CampaignDataDeliveryInput
object
Campaign-scoped data-delivery configuration. Groups Data Delivery Outputs that override advertiser-scoped delivery for the same dataDeliveryType. Distinct from…
1 property
BatchProposalSelection
object
A storefront-qualified seller proposal selected from getproducts.
3 properties
2 required
BatchProductSelection
object
A storefront-qualified proposal-less product selection from getproducts.
8 properties
2 required
DiscoverProductsBody
object
Request body for discovering products with optional auto-session creation
24 properties
1 required
DiscoveryRefinementItem
object
A refinement instruction for iterating on discovery results. Scoped to the overall request, a specific product, or a specific proposal.
AddProductsRequest
object
Request to add products to a discovery session
3 properties
1 required
ProductSelection
object
Product selection for adding to a discovery session
13 properties
1 required
RemoveProductsRequest
object
Request to remove products from a discovery session
1 property
1 required
ApplyProposalRequest
object
Apply a sales agent proposal to auto-add products with recommended budget allocations
3 properties
1 required
CampaignStatusListFilter
string
Campaign statuses to include in the list, or "ALL" to include every status. Defaults to the non-terminal statuses (ACTIVE, DRAFT, PAUSED) — every campaign that…
CampaignMode
string
Who is steering the campaign. "discovery" (brief-driven) and "performance" (objective-driven) are platform-managed. "directed" is a deprecated wire value retai…
CampaignManagementFilter
string
Management states to include in the list: "tracked", "managed", or "all" (both — the default).
CreateCampaignOpenApiBody
object
CreatePerformanceCampaignBody
object
Request body for creating a performance-mode campaign
18 properties
6 required
UpdateCampaignOpenApiBody
UpdateLegacyCampaignBody
object
17 properties
UpdateDiscoveryCampaignBody
object
Request body for updating a discovery-mode campaign
17 properties
1 required
UpdatePerformanceCampaignBody
object
Request body for updating a performance-mode campaign
17 properties
1 required
RefreshDirectedCampaignBody
object
Request body for refreshing a directed campaign mirror without an upstream mutation.
2 properties
2 required
ExecuteCampaignBody
object
Optional request body for executing a campaign. Unknown fields are rejected.
1 property
AutoSelectProductsRequest
object
Optional refinement parameters for iterative auto-select product selection. Based on ADCP refine spec.
3 properties
RefinementItem
object
A single refinement directive (request-scoped or product-scoped)
UpdateMediaBuyRequest
object
Partial update for a single media buy, resolved top-level by mediaBuyId. Rejected outright (not warned) when it would violate a campaign invariant: currency (a…
8 properties
UpdateMediaBuyPackageInput
object
Per-package update for a media buy with deployed packages
7 properties
1 required
UpdateMediaBuyProductInput
object
Product update — additive (existing products not listed are preserved). Use remove: true to delete a product. Does not add brand-new product selections; use cr…
8 properties
1 required
TargetingDimensionSystem
string
Supported targeting dimension system
CreateCreativeManifestMetadata
object
JSON metadata for creating a creative manifest
16 properties
UrlAssetSlotInput
object
URL asset assigned to an AdCP format slot. The slot assetid is the key in the creative manifest assets map.
3 properties
2 required
TextAssetSlotInput
object
Text asset assigned to an AdCP format slot. The slot assetid is the key in the creative manifest assets map.
2 properties
2 required
LinkedCreativeAssetInput
object
A linked or inline generated creative asset that can be saved into the manifest asset store without multipart file upload.
15 properties
1 required
CardInput
object
Per-card input for carousel creatives. Provide filename for multipart file uploads or url for pre-hosted assets.
7 properties
CreativeRole
string
Advertiser creative-library role: evergreen (serve-ready, reusable across campaigns) or reference (a generation input, not served). Absent for flight-specific…
CreativeSource
string
Origin of the creative: uploaded (bring-your-own), generated (by a creative agent), or connected (from a 3p platform).
BulkUpdateCreativesBody
object
Bulk update saved campaign creatives. Use dryrun first to confirm the matched set.
6 properties
2 required
BulkUpdateCreativeSelection
object
Selectors for a campaign-scoped bulk creative update
10 properties
SaveCreativesToLibraryBody
object
Promote advertiser creatives into the library ("the shelf") with a role. Identify the creatives by creativeids or by collectionid.
3 properties
1 required
AssignCreativeToCampaignBody
object
Assign an advertiser-library creative to a campaign
1 property
1 required
CreateCreativeCollectionBody
object
Create a campaign creative workspace for saved creatives and raw/generated assets.
7 properties
1 required
CreativeCollectionMemberInput
object
A saved creative or source/generated asset to add to a collection.
4 properties
2 required
UpdateCreativeCollectionBody
object
Update creative collection metadata.
3 properties
AddCreativeCollectionMembersBody
object
Add saved creatives or assets to a collection.
1 property
1 required
RemoveCreativeCollectionMembersBody
object
Remove saved creatives or assets from a collection.
1 property
1 required
AttachCreativeCollectionBody
object
Attach collection metadata to the campaign workspace. This does not launch or sync creatives by itself.
3 properties
UpdateCreativeManifestMetadata
object
JSON metadata for updating a creative manifest
19 properties
CardUpdate
object
Per-card input for updating carousel creatives.
8 properties
SyncEventSourcesRequest
object
Request body for syncing event sources (ADCP spec)
3 properties
2 required
SyncEventSourceObject
object
A single event source to sync
7 properties
1 required
EventSourceMappingInput
object
Scope3 extension: field mapping contract for a buyer event source
11 properties
EventSummaryType
string
Type of event to filter by: conversion, click, impression, measurement, or mmp
LogEventRequest
object
Request body for logging conversion or marketing events (ADCP spec)
3 properties
2 required
LogEventObject
object
A single conversion or marketing event
8 properties
3 required
UserMatch
object
User identity fields for attribution matching
7 properties
CustomData
object
Event-specific data (value, currency, items)
7 properties
ContentItem
object
Per-item detail within a conversion event
4 properties
SyncMeasurementDataRequest
object
Request body for syncing measurement data (ADCP spec alternative to CAPI)
1 property
1 required
SyncMeasurementObject
object
A single measurement data point to sync
14 properties
5 required
CreateTestCohortInput
object
Request body for creating a new test cohort
6 properties
3 required
CohortDefinition
object
Flexible definition for cohort targeting criteria. Type is required, additional fields vary by type.
1 property
1 required
UpdateTestCohortInput
object
Request body for updating a test cohort (all fields optional)
6 properties
UpdateMeasurementConfigInput
object
Request body for updating measurement configuration
4 properties
MmmConfig
object
Marketing Mix Modeling configuration with optional additional fields
3 properties
CreateChildAccountBody
object
Request body for creating a child customer account
8 properties
2 required
UpdateCustomerDomainBody
object
Request body for updating a customer's organization domain
1 property
1 required
UpdateMembershipSettingsBody
object
Request body for updating customer membership settings
1 property
1 required
CreateBrowserOriginBody
object
2 properties
1 required
AssignAccountBody
object
Request body for assigning a source account to an advertiser
5 properties
3 required
UpdateReportingBucketBody
object
Request body for updating the offline reporting bucket on a linked partner account
1 property
1 required
ReportingBucket
object
Customer-owned object storage bucket where sales agents can write offline delivery reports
8 properties
3 required
MarketReadinessRequest
object
A bounded set of ISO country × canonical channel cells to preview.
1 property
1 required
UpdateBuyerOperatorBody
object
Confirm or change the authenticated buyer account's commercial operator domain.
1 property
1 required
SubscribeDirectedCampaignsBody
object
Subscribe a mapped seller account for read-only tracked-campaign mirroring.
2 properties
1 required
ConnectAdcpStorefrontBody
object
Project a registered and advertiser-mapped AdCP storefront source into the connected-account campaign connection plane.
3 properties
2 required
SyncAudiencesBody
object
Sync audience data into Scope3
3 properties
1 required
AudienceItem
object
Audience to sync with member changes
6 properties
1 required
RemoveMember
object
Member to remove from the audience
4 properties
1 required
CreatePropertyListInput
object
Request body for creating a property list
5 properties
2 required
PropertyListIdentifier
object
A typed property identifier (AdCP-aligned, sourced from @adcp/sdk). Read-side note: Apple App Store bundles share a single backing column, so appletvbundle wri…
2 properties
2 required
PropertyListFilters
object
4 properties
UpdatePropertyListInput
object
Request body for updating a property list
3 properties
AttachPropertyListBody
object
1 property
1 required
CheckPropertyListBody
object
Request body for checking domains and bundles
2 properties
CreateMediaBillingEntityBody
object
Create a media billing entity — a legal entity Scope3 invoices for media spend.
11 properties
7 required
ErrorResponse
object
Standard error response
2 properties
2 required
ApiError
object
Structured error object
4 properties
2 required
AdvertiserListResponse
object
Response containing a paginated list of advertiser summaries
5 properties
4 required
AdvertiserSummary
object
Compact advertiser view returned by list endpoints. Use getadvertiser for the full resource.
11 properties
9 required
BrandManifestJson
object
Full brand.json profile conforming to the ADCP v2 schema
15 properties
1 required
Advertiser
object
Advertiser resource representation
17 properties
9 required
LinkedAccount
object
A partner account linked to this advertiser
8 properties
7 required
BuyerCredentialSourceRef
object
A storefront/source pair that a single credential row gives the buyer access to
4 properties
4 required
AdvertiserDataDelivery
object
Data-delivery configuration for this advertiser. Groups standing Data Delivery Outputs and the credentials they reference. Distinct from media-buy reporting fi…
2 properties
DataDeliveryCredential
object
Resolved Data Delivery Credential as returned by the API.
10 properties
7 required
CredentialConfig
object
Destination-specific auth target as stored on the credential row. AZUREBLOB omits the SAS token — the token lives in Google Secret Manager and is fetched at pr…
AzureBlobCredentialConfig
object
4 properties
4 required
AzureBlobAuthStored
object
AzureBlobSasAuthStored
object
1 property
1 required
DataDeliveryOutput
object
Resolved Data Delivery Output as returned by the API.
11 properties
10 required
FrequencyCapConfig
object
Buyer-side frequency cap configuration
8 properties
7 required
FrequencyCapTargetLevel
string
Level of the entity the frequency cap applies to
RevalidateDataDeliveryCredentialResponse
object
Updated credential after re-running the destination Probe.
1 property
1 required
AdvertiserModelCredentialList
array
AdvertiserModelCredential
object
14 properties
14 required
BuyerModelCredential
object
12 properties
12 required
ResolveBrandResponse
object
13 properties
2 required
CreativeDashboardUrlResponse
object
1 property
1 required
ProjectedGetProductsResponse
Canonical getproducts response, either complete or with product objects honoring the optional fields projection while retaining qualified identity and Intercha…
GetProductsResponse
object
Canonical flat AdCP product page with Interchange progressive and optional buyer-intelligence metadata.
29 properties
4 required
InterchangeProduct
object
Canonical AdCP product with an opaque storefront-qualified identity and attributed Interchange intelligence.
49 properties
8 required
InterchangeProposal
object
Canonical AdCP proposal with storefront-qualified proposal and allocation product identities.
11 properties
4 required
ProjectedInterchangeProduct
object
Field-projected canonical product. Requested canonical fields may be present; productid, name, and Interchange provenance are always present.
3 properties
3 required
CreateMediaBuysBatchResponse
object
Cart and per-campaign execution outcome for a multi-storefront batch.
15 properties
13 required
DiscoverProductsResponse
object
Response from discovering products
18 properties
5 required
ProductGroup
object
Group of products from a publisher
9 properties
6 required
Product
object
Product resource for campaign inventory
27 properties
2 required
ProductCardData
object
Visual card data for rendering a product in UI
5 properties
ProductCardDetailedData
object
Detailed inline product card data for buyer UIs
7 properties
PricingOptionData
object
Pricing option from a sales agent
8 properties
ProductFormatOption
object
AdCP 3.1 format declaration for a product
4 properties
ProductFormatOptionParams
object
Canonical format params. For hosted video, carries accepted containers/codecs.
3 properties
DiscoverySummary
object
Summary statistics for the discovery
3 properties
2 required
BudgetContextResponse
object
Budget allocation context
4 properties
3 required
Proposal
object
A recommended media plan with budget allocations across products (ADCP v3)
12 properties
3 required
ProductAllocation
object
Budget allocation for a product within a proposal
6 properties
2 required
IncompleteDiscoveryAgent
object
Storefront agent that did not fully complete inside the requested discovery wait window, either because the call timed out locally or because the seller return…
7 properties
4 required
IncompleteDiscoveryScope
object
A getproducts scope the upstream seller could not fully complete within the requested time budget.
3 properties
2 required
ConnectionIssue
object
An adapter connection that requires the buyer to re-authenticate before discovery can reach it.
3 properties
1 required
AgentDiscoveryResult
object
Per-agent discovery result with optional debug info. Same structure as v1 mediaproductdiscover debug output.
12 properties
4 required
AgentDebugLog
object
A single debug log entry from ADCP agent communication
5 properties
RefinementApplied
object
Seller's response to a refinement instruction, matched by position to the request's refine array
4 properties
1 required
PendingDiscoveryAgent
object
A seller still answering during a progressive discovery — it has not settled yet.
3 properties
2 required
DiscoveryDiagnostics
object
Advanced support diagnostics returned only to elevated/admin contexts.
1 property
DiscoveryTraceDiagnostics
object
Advanced support diagnostics for tracing a discovery fan-out.
3 properties
3 required
DiscoveryProductDetail
object
11 properties
2 required
SessionProductsResponse
object
Response containing selected products
6 properties
3 required
SelectedProduct
object
A product selected for inclusion in a discovery session
11 properties
5 required
ApplyProposalResponse
object
Response from applying a proposal
10 properties
7 required
AppliedProposalSummary
object
Summary of the proposal that was applied
3 properties
2 required
BuyerWebhookSubscriptionResponse
object
1 property
1 required
BuyerWebhookSubscription
object
9 properties
9 required
ListBuyerWebhookSubscriptionsResponse
object
1 property
1 required
DeleteBuyerWebhookSubscriptionResponse
object
2 properties
2 required
CampaignListResponse
object
Response containing a paginated list of campaign summaries
7 properties
3 required
CampaignSummary
object
Compact campaign view returned by list endpoints. Use getcampaign for the full resource.
13 properties
8 required
CampaignManagement
string
Whether the platform acts on this campaign. "tracked" = a campaign the platform did not set up, mirrored from a connected seller account: the shell is derived…
DirectedCampaignInfo
object
Directed campaign provenance. Connected-account campaigns expose mirror health; storefront-endpoint campaigns expose the addressed storefront and dual-key iden…
ConnectedAccountDirectedCampaignInfo
object
Subscription-backed directed campaign mirror state — connection, upstream account, dual-keyed identifiers, and sync health.
10 properties
7 required
StorefrontEndpointDirectedCampaignInfo
object
Provenance and dual-key identity for a direct buy through one storefront AdCP endpoint.
4 properties
3 required
CampaignGeoMetroNames
array
Display labels for metro codes. Returned only when requested with fields=geometronames; labels are derived from the local geo-metro label table and are not acc…
CampaignResponse
object
Response containing a single campaign
2 properties
1 required
Campaign
object
Campaign resource representation
31 properties
10 required
MediaBuyRef
object
Lightweight media buy reference (id + live status). Used in Campaign.mediaBuyRefs so callers can enumerate media buys without loading the full nested tree.
4 properties
2 required
MediaBuyRefPendingChange
object
Present when this buy has a submitted change that has not yet reached the delivering buy. Call getmediabuy for the field-level differences; this reference stay…
2 properties
1 required
CampaignStorefrontRef
object
A storefront the campaign is pinned to, hydrated from the storefront IDs the buyer set on create/update.
3 properties
3 required
MediaBuyPendingReason
string
Why a not-yet-delivering media buy is waiting, and implicitly whose side owns the wait. A platform-derived annotation — never a status value. awaitingstorefron…
BuyerMediaBuyErrorCode
string
Buyer-safe structured error code for a media buy that failed to forward or was rejected. Paired with errorOwner (who owns the fix) and, when the source provide…
MediaBuyErrorOwner
string
Which party owns fixing the error: buyerinput (the request needs a correction from the buyer), platform (Scope3 owns the fault), seller (the storefront or its…
CampaignPackageTargetingOverlay
object
Targeting carried on a campaign package; directed adapters populate provider-normalized readback when supported.
28 properties
ProviderTargetingReadback
object
Provider-normalized geographic, demographic, and audience targeting readback. Audience fields contain canonical buyer IDs, never native provider IDs. Only cano…
14 properties
4 required
CreativeReviewStatus
string
Lifecycle state of a buyer-submitted creative awaiting storefront review. pending until an operator decides; approved or rejected after a decision; revoked if…
CampaignDataDelivery
object
Resolved data-delivery configuration for this campaign. Groups standing Data Delivery Outputs (with advertiser/campaign-scoped overrides applied). Distinct fro…
1 property
DirectedCampaignDeliveryResponse
object
The campaign identifier and its owning connected seller or storefront's AdCP delivery response.
2 properties
2 required
CampaignStatusChangeResponse
object
Response from executing or pausing a campaign
8 properties
4 required
ExecutionError
object
Structured error detail for a failed media buy execution
4 properties
3 required
ExecuteMediaBuyDebugInfo
object
Full debug info including ADCP request, response, and A2A debug logs. Only present when debug=true. Same structure as v1 executemediabuy debug output.
4 properties
ExecuteWarning
object
A non-fatal outcome from campaign execution
CampaignCascadeResponse
object
Campaign cascade operation outcome, including the status change result for each media buy
8 properties
8 required
MediaBuyCascadeResult
object
Outcome of a single media buy status change in the cascade
5 properties
4 required
AutoSelectProductsResponse
object
Response from auto-selecting products for a performance campaign
6 properties
5 required
GetAdcpStatusOutput
object
10 properties
10 required
BuyerMediaBuyResponse
object
Response containing a single media buy with why-visibility
1 property
1 required
BuyerMediaBuy
object
A single media buy with its optimization goals and why-visibility annotation (pendingReason, errorCode, forwardedAt, buyerReference). Use getcampaign for packa…
17 properties
5 required
MediaBuyPendingChange
object
A buyer-submitted change that has been accepted by Interchange but has NOT yet taken effect on the delivering buy. Its presence is the signal that this buy has…
4 properties
2 required
UpdateMediaBuyResponse
object
The updated media buy (why-visibility fields included) plus any non-blocking warnings.
2 properties
1 required
BuyerMediaBuyPackagesResponse
object
A media buy's packages with the attributes needed to pick one, sized to be read in full by an agent.
4 properties
4 required
BuyerPackage
object
One package on a media buy, carrying the attributes that identify it. Targeting, creatives, and format detail are deliberately omitted; use getcampaign for tho…
11 properties
4 required
PackagePacingPeriod
object
Which pacing period a package was cut for. This is what the numeric suffix on a storefront-minted package id refers to: package ids are assigned in product-the…
2 properties
1 required
BuyerPackageDelivery
object
Delivery recorded against this package. Absent when the package has not delivered or the source has not reported yet.
3 properties
3 required
MediaBuyStatusChangeResponse
object
Response from pausing or reactivating a single media buy. Only this media buy is affected — its campaign is never cascaded.
6 properties
5 required
CampaignProductsResponse
object
Every product attached to a campaign, sourced from the campaign's media buys (authoritative) plus any discovery-staged products that have not yet been executed…
5 properties
5 required
CampaignProductEntry
object
A product staged on a campaign with discovery and execution context
13 properties
4 required
CampaignSearchContextSummary
object
Summary of a single discovery run within a campaign
6 properties
6 required
ListTargetingDimensionsResponse
object
Supported targeting dimensions and their campaign fields.
2 properties
2 required
TargetingDimensionSummary
object
6 properties
6 required
TargetingDimensionValuesResponse
object
Targeting dimension codes and localized display labels for buyer-side display and input resolution.
6 properties
6 required
TargetingDimensionEntry
object
2 properties
2 required
ResolveTargetingDimensionResponse
object
Resolution candidates for localized targeting text within a dimension.
5 properties
5 required
TargetingDimensionResolveCandidate
object
7 properties
7 required
GeoMetrosResponse
object
Geo metro codes and English display labels for buyer-side display and input resolution.
3 properties
3 required
ListBuyerActivityResponse
object
Paginated list of buyer activity audit logs
2 properties
2 required
BuyerAuditLog
object
Audit log row surfaced to the buyer activity feed
19 properties
19 required
ListActivityCallsResponse
object
Cursor-paginated customer API calls
2 properties
2 required
ActivityCall
object
One normalized, customer-authorized API call
50 properties
50 required
ActivityCallDetailResponse
object
Authorized customer API call detail and safe diagnostics
9 properties
9 required
CreativeManifestResponse
object
Creative manifest with inline assets
31 properties
5 required
ManifestAssetResponse
object
Asset within a creative manifest
21 properties
9 required
CreativeAssetControl
object
Renderer/evaluator guidance for supplied creative assets that must retain visual fidelity through generation and refinement.
6 properties
AssetDimensionWarning
object
Dimensional inconsistency detected on an uploaded asset
2 properties
2 required
CreativeManifestSyncStatus
object
Sync status across sales agents for a creative manifest.
3 properties
2 required
CreativeManifestPlatformLink
object
Readback linkage between a campaign creative and the sales agent/provider creative created during sync.
6 properties
3 required
AvailableTemplatesResponse
object
Available creative templates for a campaign
4 properties
4 required
CreativeTemplateResponse
object
Creative format template with asset requirements
9 properties
7 required
TemplateAssetRequirement
Asset slot within a creative template. Re-exported from @adcp/sdk as FormatAssetSlot — a discriminated union over itemtype (individual or repeatablegroup) per…
CreativeManifestListResponse
object
Paginated list of creative manifest summaries
2 properties
2 required
CreativeManifestSummary
object
Compact creative-manifest view returned by list endpoints. Use getcreative for the full resource.
20 properties
5 required
BulkUpdateCreativesResponse
object
Bulk creative update preview or execution result suitable for confirmation UI.
11 properties
10 required
BulkUpdateCreativeResultItem
object
A creative selected by a bulk update dry-run or execution result.
23 properties
6 required
SaveCreativesToLibraryResponse
object
Result of promoting creatives into the advertiser library.
4 properties
4 required
ListCreativeCollectionsResponse
object
Creative collection list response.
2 properties
2 required
CreativeCollectionSummary
object
A creative collection owned by an advertiser, campaign, or customer workspace.
15 properties
8 required
CreativeCollectionMemberSummary
object
A collection member with an optional creative summary when the member references a saved creative.
7 properties
4 required
CampaignCreativeCollectionAttachment
object
Campaign attachment metadata for a creative collection.
7 properties
6 required
CreativeCollectionMutationResponse
object
Mutation response for collection management.
7 properties
1 required
CreativePreviewResponse
object
4 properties
2 required
EventSourceListResponse
object
Response containing a paginated list of event sources
2 properties
2 required
EventSourceOutput
object
Event source resource representation
10 properties
10 required
EventSourceMappingOutput
object
Persisted field mapping contract for this event source
11 properties
11 required
EventSourceHealth
object
Basic ingestion health for an event source
6 properties
6 required
SyncEventSourcesResponse
object
Response from synceventsources
1 property
1 required
EventSourceSyncResult
object
Per-source result from synceventsources
4 properties
2 required
EventSourceSetup
object
AdCP setup object: install/setup guidance so events flow after a source is registered
3 properties
2 required
EventSummaryResponse
object
Response containing hourly-aggregated event counts for an advertiser
4 properties
4 required
EventSummaryEntry
object
A single hourly aggregation entry
3 properties
3 required
LogEventResponse
object
Response from logevent
5 properties
2 required
LogEventPartialFailure
object
Detail about an individual event that failed validation
3 properties
3 required
SyncMeasurementDataResponse
object
Response from syncmeasurementdata
1 property
1 required
MeasurementDataSyncResult
object
Per-record result from syncmeasurementdata
3 properties
2 required
TestCohortListResponse
object
Response containing a paginated list of test-cohort summaries
2 properties
2 required
TestCohortSummary
object
Compact test-cohort view returned by list endpoints. Use gettestcohort for the full resource.
9 properties
8 required
TestCohortResponse
object
Response containing a single test cohort
1 property
1 required
TestCohortOutput
object
Test cohort resource representation
11 properties
9 required
MeasurementConfigResponse
object
Response containing measurement configuration
1 property
1 required
MeasurementConfigOutput
object
Full measurement configuration for an advertiser
7 properties
5 required
ReportingMetricsResponse
object
Hierarchical reporting response: advertiser → campaign → media buy → package
6 properties
5 required
AdvertiserReporting
object
Advertiser-level reporting metrics with campaign breakdown
5 properties
5 required
ReportingMetrics
object
Raw and calculated reporting metrics
15 properties
15 required
CampaignReporting
object
Campaign-level reporting metrics with media buy breakdown
5 properties
5 required
MediaBuyReporting
object
Media buy-level reporting metrics with package breakdown
7 properties
6 required
PackageReporting
object
Package-level reporting metrics
4 properties
4 required
ReportingTotalsMetrics
object
Reporting totals; money metrics are null when returned denominations mix or no denomination is available
15 properties
15 required
ConsolidatedReporting
object
FX-converted cross-advertiser rollup (display estimate only — never billing)
3 properties
3 required
ReportingConversionInfo
object
How the consolidated (FX-converted) figures were produced
7 properties
7 required
ReportingMetricsTimeseriesResponse
object
Time-series reporting response: flat leaf × day rows (same hierarchy fields as the summary view, plus date)
5 properties
5 required
TimeseriesEntry
object
One row of metrics for a single (advertiser → campaign → media buy → package) leaf on a single day
14 properties
14 required
ReportingMetricsExportResponse
object
Response containing a signed URL to download the exported CSV
4 properties
4 required
OptimizationSuggestionList
object
3 properties
3 required
OptimizationSuggestionListItem
object
9 properties
9 required
OptimizationSuggestionDetail
object
15 properties
15 required
OptimizationSuggestionStatus
object
2 properties
2 required
AsksResponse
object
7 properties
3 required
SupplyRequestSuggestionsResponse
object
1 property
1 required
SupplyRequestSuggestionItem
object
4 properties
4 required
SupplyRequestListResponse
object
7 properties
7 required
SupplyRequestItem
object
8 properties
8 required
PublicSupplyRequestStatus
object
4 properties
3 required
RequestSupplyResponse
object
4 properties
4 required
RemoveSupplyRequestResponse
object
2 properties
2 required
CurrentAccountResponse
object
Current customer account context
6 properties
4 required
ListCustomerAccountsResponse
object
List of customer accounts for the authenticated user
1 property
1 required
OrgAccountSummary
object
Summary of a customer organization account
4 properties
3 required
CreateChildAccountResponse
object
Full user context scoped to the new child customer
10 properties
8 required
UpdateCustomerDomainResponse
object
Updated customer domain
3 properties
3 required
MembershipSettingsResponse
object
Customer membership access settings
2 properties
2 required
BrowserOriginsResponse
object
1 property
1 required
BrowserOrigin
object
7 properties
7 required
NotificationListResponse
object
Paginated list of notification summaries
4 properties
4 required
NotificationSummary
object
Compact notification view returned by list endpoints. Use the notification detail endpoint for the full data payload.
8 properties
8 required
NotificationActionResponse
object
2 properties
2 required
AccountListResponse
object
Response containing a paginated list of linked-account summaries
2 properties
2 required
AccountSummary
object
Compact linked-account view returned by list endpoints. Use getadvertiseraccount for the full resource.
8 properties
7 required
AdvertiserAccount
object
13 properties
12 required
AvailableAccountListResponse
object
Response containing a list of available accounts from a partner
4 properties
2 required
AvailableAccountOutput
object
Discovered account available to be linked to an advertiser
9 properties
3 required
AccountUnlinked
object
1 property
1 required
AccountResponse
object
Response containing a single linked account
1 property
1 required
AccountOutput
object
Linked account resource on a partner platform
14 properties
7 required
MarketReadinessResponse
object
Human-decided pilot state with separate domestic and global-overlay supply evidence.
1 property
1 required
MarketReadinessSupplyItem
object
Public-safe supply evidence for one scope. Unknown is distinct from a successful empty read.
5 properties
5 required
BuyerReadiness
object
Canonical buyer setup projection. mediaRateCard is the configured legacy media-pricing contract and is distinct from the feature-gated IU plan; interchangeClea…
9 properties
9 required
BuyerReadinessCheck
object
6 properties
6 required
BuyerReadinessAction
object
Server-owned continuation for one buyer setup step. Operations are executed through buyer apicall; pages are opened through their typed owner.
4 properties
4 required
BuyerDestinationReadiness
object
Buyer-specific readiness for one seller or buying platform. Seller availability, connection wiring, and commercial routing remain separate inputs.
10 properties
10 required
BuyerOperatorUpdate
object
Confirmed buyer-account operator identity. Authentication organization membership is unchanged.
5 properties
5 required
BuyerStorefrontList
object
Paginated list of storefront summaries available to a buyer
4 properties
4 required
BuyerStorefrontSummary
object
Compact storefront view returned by list endpoints. Use the storefront detail endpoint for the full resource.
24 properties
24 required
BuyerStorefrontBrandColors
object
Validated brand.json colors object for rendering buyer discovery cards. Null when unresolved.
BuyerStorefrontReadiness
object
Canonical transaction eligibility for this storefront. This is independent of buyer credential connection state.
3 properties
3 required
BuyerCreativeStorefrontCapability
object
Machine-readable creative generation capability summary for an adapter storefront.
8 properties
8 required
BuyerAdapterConnectionStatus
object
Buyer-specific delegated-auth status for an official adapter storefront.
5 properties
5 required
BuyerStorefrontDiscoveryPerformance
object
Observed buyer product-discovery response timing for this storefront.
7 properties
7 required
BuyerDiscoveryCardSummary
object
Compact Discovery Card for Marketplace lists. Full Advertising Policies are detail-only.
17 properties
17 required
BuyerStorefront
object
A storefront as seen by a buyer
27 properties
26 required
DiscoveryCard
object
Canonical buyer-visible storefront identity, coverage declaration, and optional Advertising Policies disclosure. Unknown coverage never means worldwide or all…
16 properties
16 required
BuyerStorefrontAccount
object
A buyer's registered account for a storefront
2 properties
2 required
BuyerStorefrontAdcpCapabilities
object
AdCP capability manifest for a storefront's underlying agent(s), derived from the cached getadcpcapabilities response. Check capabilitiesCachedAt for data fres…
15 properties
12 required
BuyerStorefrontCapabilitiesResponse
object
Source-level capability diagnostics for a buyer storefront
2 properties
2 required
BuyerStorefrontCapabilitySource
object
Source-level storefront capability diagnostic row
9 properties
9 required
BuyerStorefrontCapabilityDetails
object
Capability summary for an external AdCP storefront source
14 properties
11 required
StorefrontConnectionsResponse
object
Storefront connection rows and feature policies visible to a buyer.
1 property
1 required
StorefrontConnectionSummary
object
Buyer-side storefront connection row. Adapter storefronts include auth status; all storefronts include feature policy.
12 properties
9 required
StorefrontConnectionAgentSource
object
Agent-backed inventory source eligible for external account mappings.
2 properties
2 required
StorefrontConnectionFeaturePolicy
object
Buyer-controlled feature policy for a storefront connection row.
4 properties
4 required
StorefrontConnectionAccount
object
Provider account discovered for a buyer storefront connection.
20 properties
19 required
StorefrontConnectionAccountAdvertiserMapping
object
Advertiser mapping for an external account discovered through an integration.
9 properties
9 required
StorefrontConnectionAccountCampaignRollup
object
Directed-campaign rollup for one connected account: tracked = mirrored read-only from the connected seller account; managed = authored through the platform. Sp…
7 properties
7 required
StorefrontConnectionAccountMappingsResponse
object
Paginated external account mapping table for buyer integrations.
4 properties
4 required
StorefrontConnectionAccountMappingItem
object
External provider account row for integration-to-advertiser mapping management.
18 properties
18 required
StorefrontConnectionAccountsResponse
object
External accounts discovered for an integration, including advertiser mappings.
1 property
1 required
StorefrontConnectionArchived
object
1 property
1 required
SubscribeDirectedCampaignsResponse
object
The durable subscription plus the initial one-year mirror reconciliation.
2 properties
2 required
DirectedCampaignSubscription
object
Durable provider-account subscription and its read-only mirror health.
22 properties
22 required
DirectedCampaignSyncOutcome
object
Counts and bounded safe diagnostics from one account-wide mirror reconciliation.
10 properties
5 required
UnsubscribeDirectedCampaignsResponse
object
The archived directed-campaign subscription and number of retired mirrors.
2 properties
2 required
StorefrontPresenceListResponse
object
Paginated list of tracked/pushed presences for a storefront connection account. Offset pagination rides the standard response meta, not the body.
2 properties
2 required
StorefrontPresence
object
Read-only wire projection of a storefront-connection-account presence edge -- identity, status, and counts only, never member lists or event payloads.
12 properties
10 required
StorefrontConnectionHandoff
object
5 properties
5 required
BuyerCredential
object
A buyer's registered credential, scoped to the storefront sources it gives access to
8 properties
8 required
BuyerCredentialRegistrationResponse
object
Response for registering credentials against a storefront inventory source
6 properties
5 required
BuyerCredentialOAuthInfo
object
OAuth authorization info presented in buyer-facing storefront/source terms
4 properties
4 required
ConnectedAdcpStorefront
object
Connection/account identifiers for a registered AdCP storefront source ready for an explicit tracked-campaign subscription.
9 properties
9 required
SyndicateResponse
object
Response after toggling syndication for one or more ADCP agents
1 property
1 required
SyndicationStatusOutput
object
Syndication status record
17 properties
17 required
SyndicationStatusListResponse
object
Paginated list of syndication status records
2 properties
2 required
SyncAudiencesResponse
object
Audience sync accepted for async processing
4 properties
4 required
AudienceListResponse
object
Paginated list of audience summaries
4 properties
4 required
AudienceSummary
object
Compact audience view returned by list endpoints. Use getaudience for the full resource.
9 properties
9 required
TaskResponse
object
Response containing a single task
1 property
1 required
TaskOutput
object
Async task resource representation
11 properties
11 required
TaskError
object
AdCP-compatible error object
7 properties
2 required
PropertyListListResponse
object
Response containing a paginated list of property-list summaries
2 properties
2 required
PropertyListSummary
object
Compact property-list view returned by list endpoints. Use getpropertylist for full content.
6 properties
6 required
PropertyListResponse
object
Response containing a single property list
1 property
1 required
PropertyListOutput
object
Property list resource representation
17 properties
12 required
PropertyListResolutionSummary
object
Counts describing how a submitted identifier set resolved against the AAO registry and local catalog.
5 properties
5 required
PropertyListCascadeSummary
object
Summary of the retroactive push of this updated property list to active media buys.
3 properties
3 required
EmptyResponse
object
No content
CampaignPropertyListsResponse
object
Property lists referenced by a campaign, derived from targetingoverlay.propertylist on the campaign media-buy packages.
3 properties
3 required
CampaignPropertyListEntry
object
A property list referenced by one or more media-buy packages on a campaign, with the list summary plus the media-buy/package references that pull it in.
7 properties
7 required
AttachPropertyListResponse
object
3 properties
3 required
AttachCascadeSummary
object
4 properties
4 required
GetBillingInfoResponse
object
1 property
1 required
BuyerBillingInfo
object
Billing (payer) information for the authenticated customer, used on manually issued invoices.
11 properties
11 required
UpdateBillingInfoResponse
object
1 property
1 required
GetBillingAccountResponse
object
1 property
1 required
BillingAccountDocument
object
The consolidated commercial-account read model — GET /api/v2/billing/account.
13 properties
13 required
BillingOrganization
object
5 properties
5 required
BillingCapabilities
object
Capability derived from the org's own role UNION its children's roles. Always present — computed server-side so no consumer decides capability from roles alone…
2 properties
2 required
LedgerCurrency
string
ISO 4217 currency code supported by the ledger. Mirrors the ledger.isocurrency ENUM.
BillingScope
object
2 properties
2 required
BillingStanding
object
5 properties
5 required
BillingHold
object
A payment hold blocking NEW paid actions (meter-first, block narrow — spec §5.4/§12 ruling 5). Never blocks read access, reporting, export, in-flight deliverin…
4 properties
4 required
BillingPlan
object
9 properties
9 required
BillingPricing
object
3 properties
3 required
BillingRateCard
object
2 properties
2 required
BillingUsage
object
4 properties
4 required
BillingIntelligenceUsage
object
4 properties
4 required
CreditBalanceSummary
object
A customer’s credit/prepay position: their ledger balance sheet plus the derived funded / owed / spendable figures, all in currency minor units.
8 properties
8 required
LedgerAccountBalance
object
One ledger account and its current balance for the customer.
4 properties
4 required
BillingOrgFinancialPosition
object
Org-wide rollup across the customer subtree (getOrgFinancialPosition — this read model is its first caller).
8 properties
8 required
BillingIuAccount
object
IU (Intelligence Unit) account snapshot (AI-3079 slice 2a) — one pool per org, storefront and buyer usage combined. Null unless iu-account-experience is on for…
12 properties
12 required
IuBucketBalance
object
3 properties
3 required
IuOverageStatus
object
6 properties
6 required
BillingIuAccountRatingTerms
object
2 properties
2 required
BillingPayment
object
7 properties
7 required
BillingBillingInfo
object
13 properties
13 required
BillingPaymentMethod
object
The org’s active card-rail payment method (AI-3078). Null until one is added — never a PAN, never a PSP token.
6 properties
6 required
BillingStorefrontBillingSummary
object
Commercial-terms summary only — null for an org with no seller role. Payout bank details stay on their own surface (AI-2832), never duplicated here.
4 properties
4 required
CreditApplicationResponse
object
A single credit application.
14 properties
14 required
BillingDeposit
object
One prepay deposit, projected read-only from the ledger’s DEPOSIT journal entries.
7 properties
7 required
BillingContracts
object
3 properties
3 required
BillingAgreement
object
7 properties
7 required
BillingEnterpriseContracts
object
The authoritative Enterprise Contract position shared by Plan & Billing and MCP: pending Offer, customer-safe Rate Card acceptance lineage, purchased product r…
4 properties
4 required
BillingEnterpriseCommercialState
object
Customer-safe Enterprise Contract commercial state. The immutable customer proposal is present for human admins and principal-redacted for service tokens; free…
13 properties
13 required
IuRateCardActivityScheduleResponse
BillingEnterpriseContractPackage
object
One immutable accepted Enterprise Contract package with a server-derived lifecycle. Purchased rights remain visible through funding gaps, billing holds, expiry…
4 properties
4 required
BillingAccountChild
object
6 properties
6 required
NextAction
object
The single most-important action needed to become or remain paid, derived server-side — never stored.
5 properties
5 required
BillingPermissions
object
3 properties
3 required
GetIuRateCardOfferResponse
object
1 property
1 required
GetIuRateCardOfferV2Response
object
1 property
1 required
CommercialOfferDocumentPdf
string
AcceptIuRateCardOfferResponse
object
1 property
1 required
SetupPaymentMethodResponse
object
Everything the client needs to mount an embedded card-capture form. The resulting payment method is NOT returned here — it appears once the card rail webhook c…
2 properties
2 required
PaymentMethodListResponse
object
1 property
1 required
PaymentMethodResponse
object
A vaulted payment method. Never a PAN, never a raw PSP token — display-safe metadata only.
8 properties
8 required
RemovePaymentMethodResponse
object
1 property
1 required
CaptureLinkExchangeResponse
object
Validates the capture-link token, marks it opened, and returns everything the hosted page needs to mount the embedded card form (or render the current status i…
5 properties
2 required
PayNowResponse
object
Immediate result of a manual "pay now" retry (spec §5.4: self-serve, instant recovery). The actual state transition (recovered, or unchanged on a decline) happ…
2 properties
2 required
InvoiceActivityResponse
object
Invoice activity for the caller’s org, newest first. Empty until the first billing period closes.
1 property
1 required
InvoiceActivityRow
object
One row of invoice activity for a buyer (or seller) org.
10 properties
5 required
FeeInvoiceListResponse
object
Fee invoices for the caller’s org, newest first. Empty until the org’s first charged billing cycle closes.
1 property
1 required
FeeInvoiceSummary
object
One fee invoice, without its lines — the list-view shape. Fetch the invoice by number for line detail.
9 properties
9 required
FeeInvoice
object
One fee invoice with its line items.
10 properties
10 required
FeeInvoiceLine
object
One line item on a fee invoice.
6 properties
6 required
ListMediaBillingEntitiesResponse
object
Media billing entities configured for the org.
1 property
1 required
MediaBillingEntity
object
A media billing entity — a legal entity Scope3 invoices for media spend.
14 properties
11 required
CreateMediaBillingEntityResponse
object
1 property
1 required
UpdateMediaBillingEntityResponse
object
1 property
1 required
DeleteMediaBillingEntityResponse
object
ListMediaBillingAttachmentsResponse
object
Media billing attachments configured for the org.
1 property
1 required
MediaBillingAttachment
object
Routes one advertiser or account (child customer) to a media billing entity.
6 properties
6 required
CreateMediaBillingAttachmentResponse
object
1 property
1 required
DeleteMediaBillingAttachmentResponse
object
ResolveMediaBillingEntityResponse
object
Answers "who gets this invoice" for an advertiser or account: the resolved media billing entity and which level of the hierarchy it came from.
2 properties
2 required
GcsCredentialConfigOutput
object
2 properties
2 required
S3CredentialConfigOutput
object
3 properties
3 required
DeliveryConfigOutput
object
Per-Output destination shape (non-secret). Additional destination types are added as new variants in this discriminated union.
GcsDeliveryConfigOutput
object
3 properties
3 required
S3DeliveryConfigOutput
object
3 properties
3 required
AzureBlobDeliveryConfigOutput
object
3 properties
3 required
PacingPeriodsOutput
object
Defines a pacing schedule for a campaign. Periods represent time windows with varying spend intensity. Gaps between periods are treated as pauses (no spend). U…
2 properties
2 required
PerformanceConfigOutput
object
Configuration for performance campaign optimization
1 property
1 required
OptimizationGoalOutput
object
A single optimization target. Either kind "event" (conversion events) or kind "metric" (seller-native delivery metric).
EventGoalOutput
object
Optimize for advertiser-tracked conversion events via event sources.
5 properties
2 required
OptimizationAttributionWindowOutput
object
Attribution window for conversion optimization
2 properties
1 required
DurationOutput
object
A duration expressed as an interval and unit
2 properties
2 required
MetricGoalOutput
object
Optimize for a seller-tracked delivery metric. No event source required.
5 properties
2 required
BulkUpdateCreativeSelectionOutput
object
Selectors for a campaign-scoped bulk creative update
10 properties
PropertyListFiltersOutput
object
4 properties
PendingConfirmationResult
object
4 properties
4 required
CaptureLinkIssuedResult
object
4 properties
3 required
McpInitializeRequest
object
4 properties
4 required
McpInitializeResponse
object
3 properties
McpApiCallRequest
object
4 properties
4 required
McpAskCapabilityRequest
object
4 properties
4 required
McpToolResponse
object
3 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Scope3 12
Other APIs Scope3 publishes across the network.
Scope3 Interchange Storefront API
Scope3 AI Impact Measurement API
Scope3 Benchmarks API
Scope3 Creative API
Scope3 Data API
Scope3 Gpu API
Scope3 Impact API
Scope3 Measure API
Scope3 Model API
Scope3 Node API
Scope3 Reload API
Scope3 Saved Lists API
#Agentic#Advertising#AdTech#AdCP#MCP
Where this information came from
This is an independent, third-party profile of Scope3 Interchange Buyer API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.