> ## 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. # List advertisers > List all advertisers with optional filtering and pagination. ## OpenAPI ````yaml /v2/buyer-api-v2.yaml get /advertisers 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: /advertisers: get: tags: - Advertisers summary: List advertisers description: List all advertisers with optional filtering and pagination. operationId: listAdvertisers parameters: - in: query name: status schema: default: ACTIVE description: >- Filter by advertiser status. Use ALL to include both active and archived. Defaults to ACTIVE. type: string enum: - ACTIVE - ARCHIVED - ALL description: >- Filter by advertiser status. Use ALL to include both active and archived. Defaults to ACTIVE. - in: query name: name schema: description: Filter by advertiser name (case-insensitive, partial match) example: Acme type: string description: Filter by advertiser name (case-insensitive, partial match) - in: query name: search schema: description: >- Search advertiser names or IDs before pagination. Name matching is case-insensitive; both names and IDs support partial matches. example: '12345' type: string minLength: 1 maxLength: 200 description: >- Search advertiser names or IDs before pagination. Name matching is case-insensitive; both names and IDs support partial matches. - in: query name: linkedAccountPartnerId schema: description: >- Filter to advertisers linked to at least one account from this partner / sales agent ID. example: snap type: string description: >- Filter to advertisers linked to at least one account from this partner / sales agent ID. - in: query name: sandbox schema: description: >- Filter by sandbox mode. true returns only sandbox advertisers, false returns only production advertisers. Omit to return all. type: boolean description: >- Filter by sandbox mode. true returns only sandbox advertisers, false returns only production advertisers. Omit to return all. - in: query name: includeBrand schema: description: >- When true, include linked brand identity data on advertiser summary rows so creative agents can use brand logos, colors, tone, and catalog data. type: boolean description: >- When true, include linked brand identity data on advertiser summary rows so creative agents can use brand logos, colors, tone, and catalog data. - in: query name: limit schema: default: 100 description: >- Maximum number of advertisers to return per page (default: 100, max: 100) example: 100 type: integer minimum: 0 exclusiveMinimum: true maximum: 100 description: >- Maximum number of advertisers to return per page (default: 100, max: 100) - in: query name: offset schema: default: 0 description: 'Number of advertisers to skip for pagination (default: 0)' example: 0 type: integer minimum: 0 maximum: 9007199254740991 description: 'Number of advertisers to skip for pagination (default: 0)' responses: '200': description: List advertisers content: application/json: schema: $ref: '#/components/schemas/AdvertiserListResponse' '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: AdvertiserListResponse: type: object properties: items: type: array items: $ref: '#/components/schemas/AdvertiserSummary' description: >- Advertisers projected to the summary shape. Use `get_advertiser` for the full resource. total: type: integer minimum: 0 maximum: 9007199254740991 description: Total count of advertisers matching the query example: 42 hasMore: type: boolean description: Whether there are more results available nextOffset: nullable: true description: >- Offset to use for the next page of results, or null if no more results type: integer minimum: 0 maximum: 9007199254740991 currentAdvertiserId: description: >- The advertiser ID currently scoped by the caller (from X-SCOPE3-SEAT-ID header). Present only when the caller has an active advertiser scope (AI-5568). Used by the all-advertisers-home widget to mark the current advertiser. example: '12345' type: string required: - items - total - hasMore - nextOffset additionalProperties: false description: Response containing a paginated list of advertiser summaries 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 AdvertiserSummary: type: object properties: id: type: string description: Unique identifier for the advertiser example: '12345' name: type: string description: Name of the advertiser example: Acme Corp status: type: string enum: - ACTIVE - ARCHIVED description: Current status of the advertiser sandbox: type: boolean description: >- When true, this advertiser is in sandbox mode. All ADCP operations use sandbox-flagged accounts. Cannot be changed after creation. brand: description: The brand domain associated with this advertiser example: nike.com type: string linkedBrand: description: >- The brand linked to this advertiser. Only present when includeBrand=true is passed to the list endpoint. type: object properties: id: type: string description: Brand ID example: brand_123 name: type: string description: Brand name example: Acme Brand domain: type: string description: Brand domain example: acme.com manifest: description: >- Full resolved brand identity data — includes logos, colors, fonts, tone, tagline, assets, product catalog, disclaimers, and more allOf: - $ref: '#/components/schemas/BrandManifestJson' logoUrl: description: Primary brand logo URL example: https://acme.com/logo.png type: string industry: description: Brand industry example: Technology type: string colors: description: Brand color palette example: primary: '#FF5733' type: object additionalProperties: type: string tagline: description: Brand tagline example: Innovation for Everyone type: string tone: description: Brand voice and tone example: Professional, friendly, and innovative type: string required: - id - name - domain - manifest additionalProperties: false primaryCurrency: type: string minLength: 3 maxLength: 3 pattern: ^[A-Z]{3}$ description: >- ISO 4217 currency for this advertiser. Every campaign under this advertiser is created in this currency, and selected product pricing must match it. example: USD brandCountries: type: array items: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW description: >- Canonical country qualifiers for this advertiser's BrandKey scope. Empty means no country qualifier when brandCountriesKnown is true. Campaigns may inherit this market scope and refine it with delivery targeting. preferredTimezone: nullable: true description: >- Preferred IANA timezone. A connected seller may use a different fixed or assigned timezone. example: Europe/Amsterdam type: string reportingTimezoneLocked: type: boolean description: >- True once the advertiser has at least one campaign or linked seller account. While false, the reporting time-zone preference can still be changed. channels: type: array items: anyOf: - type: string enum: - display - type: string enum: - olv - type: string enum: - social - type: string enum: - search - type: string enum: - ctv - type: string enum: - linear_tv - type: string enum: - radio - type: string enum: - streaming_audio - type: string enum: - podcast - type: string enum: - dooh - type: string enum: - ooh - type: string enum: - print - type: string enum: - cinema - type: string enum: - email - type: string enum: - gaming - type: string enum: - retail_media - type: string enum: - influencer - type: string enum: - affiliate - type: string enum: - product_placement - type: string enum: - sponsored_intelligence description: >- Editable AdCP media-channel preferences for this advertiser. These do not represent seller qualification or guaranteed supply. currencyLocked: type: boolean description: >- True once the advertiser has at least one campaign or seller-account binding. Direct v2 API clients may change currency only while this is false; the canonical UI keeps Currency read-only after creation. createdAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: When the advertiser was created (ISO 8601) example: '2025-01-15T10:30:00Z' updatedAt: type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ description: When the advertiser was last updated (ISO 8601) example: '2025-01-20T14:45:00Z' linkedAccountCount: type: integer minimum: 0 maximum: 9007199254740991 description: >- Number of partner accounts linked to this advertiser. Replaces the embedded `linkedAccounts[]` array on summary rows; call `get_advertiser` for the full account list. example: 3 required: - id - name - status - sandbox - primaryCurrency - brandCountries - preferredTimezone - reportingTimezoneLocked - channels - currencyLocked - createdAt - updatedAt - linkedAccountCount additionalProperties: false description: >- Compact advertiser view returned by list endpoints. Use `get_advertiser` for the full resource. 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 BrandManifestJson: type: object properties: name: type: string minLength: 1 maxLength: 500 description: Brand name (required) example: Acme Corporation url: description: Brand website URL example: https://www.acme.com type: string format: uri logos: description: Brand logos type: array items: type: object properties: url: type: string format: uri description: URL to the logo image tags: description: Tags categorizing the logo (e.g., "primary", "dark", "square") type: array items: type: string background: description: >- Backdrop the logo is designed for (dark-bg for a light or knockout logo, light-bg for a dark logo, transparent-bg for a logo with no baked-in background). type: string enum: - dark-bg - light-bg - transparent-bg width: description: Width of the logo in pixels type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 height: description: Height of the logo in pixels type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 required: - url additionalProperties: {} colors: description: Brand color palette type: object properties: primary: description: Primary brand color in hex format example: '#FF5733' type: string pattern: ^#[0-9A-Fa-f]{6}$ secondary: description: Secondary brand color in hex format type: string pattern: ^#[0-9A-Fa-f]{6}$ accent: description: Accent brand color in hex format type: string pattern: ^#[0-9A-Fa-f]{6}$ background: description: Background color in hex format type: string pattern: ^#[0-9A-Fa-f]{6}$ text: description: Text color in hex format type: string pattern: ^#[0-9A-Fa-f]{6}$ additionalProperties: {} fonts: description: Brand typography anyOf: - type: object properties: primary: description: Primary font family name example: Roboto type: string secondary: description: Secondary font family name type: string fontUrls: description: URLs to font files type: array items: type: string format: uri additionalProperties: {} - type: array items: type: object properties: name: type: string role: type: string required: - name additionalProperties: {} description: Font list from enrichment sources (Brandfetch format) tone: description: Brand voice and tone description example: Professional, friendly, and innovative type: string maxLength: 2000 tagline: description: Brand tagline or slogan example: Innovation for Everyone type: string maxLength: 500 assets: description: Brand assets (images, videos, etc.) type: array items: type: object properties: assetId: type: string description: Unique identifier for the asset assetType: type: string description: Type of asset (e.g., "image", "video", "audio") url: type: string format: uri description: URL to the asset name: description: Human-readable name for the asset type: string description: description: Description of the asset type: string tags: description: Tags categorizing the asset type: array items: type: string width: description: Width in pixels (for images/videos) type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 height: description: Height in pixels (for images/videos) type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 durationSeconds: description: Duration in seconds (for audio/video) type: number minimum: 0 exclusiveMinimum: true fileSizeBytes: description: File size in bytes type: integer minimum: 0 exclusiveMinimum: true maximum: 9007199254740991 format: description: File format (e.g., "png", "mp4") type: string metadata: description: Additional metadata type: object additionalProperties: {} required: - assetId - assetType - url additionalProperties: {} productCatalog: description: Product catalog configuration type: object properties: feedUrl: type: string format: uri description: URL to the product feed feedFormat: description: Format of the product feed type: string enum: - google_merchant_center - facebook_catalog - custom categories: description: Product categories type: array items: type: string lastUpdated: description: When the catalog was last updated (ISO 8601) type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updateFrequency: description: How often the catalog is updated type: string enum: - realtime - hourly - daily - weekly required: - feedUrl additionalProperties: {} disclaimers: description: Legal disclaimers and required text type: array items: type: object properties: text: type: string description: Disclaimer text context: description: Context in which the disclaimer applies type: string required: default: true description: Whether the disclaimer is required type: boolean required: - text - required additionalProperties: {} industry: description: Industry or sector example: Technology type: string maxLength: 255 advertiserIndustry: description: >- Canonical AdCP advertiser-industry code (normalized from the free-text industry). Drives category-based starter briefs and cross-platform interop. example: food_beverage.restaurants type: string enum: - automotive - automotive.electric_vehicles - automotive.parts_accessories - automotive.luxury - beauty_cosmetics - beauty_cosmetics.skincare - beauty_cosmetics.fragrance - beauty_cosmetics.haircare - cannabis - cpg - cpg.personal_care - cpg.household - dating - education - education.higher_education - education.online_learning - education.k12 - energy_utilities - energy_utilities.renewable - fashion_apparel - fashion_apparel.luxury - fashion_apparel.sportswear - finance - finance.banking - finance.insurance - finance.investment - finance.cryptocurrency - food_beverage - food_beverage.alcohol - food_beverage.restaurants - food_beverage.packaged_goods - gambling_betting - gambling_betting.sports_betting - gambling_betting.casino - gaming - gaming.mobile - gaming.console_pc - gaming.esports - government_nonprofit - government_nonprofit.political - government_nonprofit.charity - healthcare - healthcare.pharmaceutical - healthcare.medical_devices - healthcare.wellness - home_garden - home_garden.furniture - home_garden.home_improvement - media_entertainment - media_entertainment.podcasts - media_entertainment.music - media_entertainment.film_tv - media_entertainment.publishing - media_entertainment.live_events - pets - professional_services - professional_services.legal - professional_services.consulting - real_estate - real_estate.residential - real_estate.commercial - recruitment_hr - retail - retail.ecommerce - retail.department_stores - sports_fitness - sports_fitness.equipment - sports_fitness.teams_leagues - technology - technology.software - technology.hardware - technology.ai_ml - telecom - telecom.mobile_carriers - telecom.internet_providers - transportation_logistics - travel_hospitality - travel_hospitality.airlines - travel_hospitality.hotels - travel_hospitality.cruise - travel_hospitality.tourism targetAudience: description: Target audience description example: Small business owners aged 25-45 type: string maxLength: 1000 contact: description: Contact information type: object properties: email: description: Contact email address type: string format: email pattern: >- ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ phone: description: Contact phone number type: string website: description: Contact website URL type: string format: uri additionalProperties: {} metadata: description: Manifest metadata type: object properties: createdDate: description: When the manifest was created (ISO 8601) type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ updatedDate: description: When the manifest was last updated (ISO 8601) type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ version: description: Version of the manifest example: 1.0.0 type: string additionalProperties: {} required: - name additionalProperties: {} description: Full brand.json profile conforming to the ADCP v2 schema securitySchemes: bearerAuth: type: http scheme: bearer description: API key or access token ````