> ## Documentation Index > Fetch the complete documentation index at: https://developers.everflow.io/llms.txt > Use this file to discover all available pages before exploring further. # Get Advertiser by ID Retrieve a single advertiser by its ID. Use the `relationship` query parameter to include related data. Repeat the parameter for multiple relationships (e.g. `?relationship=labels&relationship=billing`). ## OpenAPI ````yaml openapi/advertisers.yaml get /networks/advertisers/{advertiserId} openapi: 3.0.3 info: title: Everflow Network API - Advertisers description: > Endpoints for managing advertisers in the Everflow network. To learn more about advertisers, see the [Advertiser overview](https://helpdesk.everflow.io/customer/who-is-an-advertiser-in-everflow). version: 1.0.0 servers: - url: https://api.eflow.team/v1 security: [] tags: - name: Advertisers paths: /networks/advertisers/{advertiserId}: get: tags: - Advertisers summary: Get Advertiser by ID parameters: - in: path name: advertiserId required: true schema: type: integer description: The unique advertiser ID. - in: query name: relationship schema: type: string enum: - reporting - labels - demand_partner - billing - integrations - api - settings - product_feed - deal description: > Include related data in the response. Available relationships: - `reporting` — Includes reporting information (clicks, conversions, revenue, etc.) - `labels` — Includes a list of labels associated to the advertiser - `demand_partner` — Includes the Everxchange information associated to the advertiser - `billing` — Includes the billing information associated to the advertiser - `integrations` — Includes the integration settings associated to the advertiser - `api` — Includes the advertiser's API keys and whitelisted IPs - `settings` — Includes the advertiser's settings (exposed variables) - `product_feed` — Includes product feeds configured for this advertiser - `deal` — Includes deals configured for this advertiser responses: '200': description: '' content: application/json: example: network_advertiser_id: 66 network_id: 1 name: DocTest Updated Advertiser account_status: active network_employee_id: 2 internal_notes: Updated notes via API address_id: 2 is_contact_address_enabled: true sales_manager_id: 2 is_expose_publisher_reporting_data: null default_currency_id: USD platform_name: Adjust platform_url: https://adjust.com platform_username: adjuser reporting_timezone_id: 90 accounting_contact_email: billing@test.com verification_token: updatedtoken123 offer_id_macro: oid affiliate_id_macro: affid time_created: 1774618267 time_saved: 1774619075 relationship: labels: total: 1 entries: - updated-label account_manager: first_name: Justin last_name: Black email: jblack@example.com work_phone: '9781243585' cell_phone: '' instant_messaging_id: 0 instant_messaging_identifier: '' reporting: imp: 0 total_click: 0 unique_click: 0 invalid_click: 0 duplicate_click: 0 gross_click: 0 ctr: 0 cv: 0 invalid_cv_scrub: 0 view_through_cv: 0 total_cv: 0 event: 0 cvr: 0 evr: 0 cpc: 0 cpm: 0 cpa: 0 epc: 0 rpc: 0 rpa: 0 rpm: 0 payout: 0 revenue: 0 event_revenue: 0 gross_sales: 0 profit: 0 margin: 0 roas: 0 avg_sale_value: 0 media_buying_cost: 0 on_hold_potential_revenue: 0 on_hold_potential_payout: 0 on_hold_conversion_count: 0 public_events: 0 contact_address: address_id: 2 network_id: 1 address_1: 456 Oak Ave address_2: Floor 3 city: San Francisco region_code: CA country_id: 227 country_code: US zip_postal_code: '94102' api_keys: total: 0 entries: [] api_whitelist_ips: total: 0 entries: [] billing: network_id: 1 network_advertiser_id: 66 billing_frequency: monthly invoice_amount_threshold: 50 tax_id: 987-65-4321 is_invoice_creation_auto: true auto_invoice_start_date: '2026-04-01 00:00:00' default_invoice_is_hidden: false invoice_generation_days_delay: 10 default_payment_terms: 30 relationship: monthly: day_of_month: 1 settings: network_id: 1 network_advertiser_id: 66 exposed_variables: affiliate_id: true affiliate: false sub1: true sub2: true sub3: false sub4: false sub5: false sub6: false sub7: false sub8: false sub9: false sub10: false source_id: false offer_url: true time_saved: 1774619075 sale_manager: first_name: Justin last_name: Black email: jblack@example.com work_phone: '9781243585' cell_phone: '' instant_messaging_id: 0 instant_messaging_identifier: '' attribution_method: last_touch email_attribution_method: last_affiliate_attribution attribution_priority: click schema: $ref: '#/components/schemas/Advertiser' '404': description: Advertiser not found. security: - API Key: [] components: schemas: Advertiser: type: object properties: network_advertiser_id: type: integer description: Unique advertiser ID. network_id: type: integer description: Network ID. name: type: string description: Advertiser name. account_status: type: string enum: - active - inactive - pending - suspended description: Current account status. network_employee_id: type: integer description: Account manager employee ID. sales_manager_id: type: integer description: Sales manager employee ID. internal_notes: type: string description: Private notes visible only to network users. default_currency_id: type: string description: >- ISO currency code for the advertiser's default currency (e.g. "USD"). platform_name: type: string description: Shopping cart or attribution platform name (e.g. Shopify, Adjust). platform_url: type: string description: URL for logging into the advertiser's platform. platform_username: type: string description: Username for the advertiser's platform. reporting_timezone_id: type: integer description: Timezone ID used for this advertiser's reporting. attribution_method: type: string enum: - first_touch - last_touch description: Click attribution method. email_attribution_method: type: string enum: - last_affiliate_attribution - first_affiliate_attribution description: Email-based attribution method. attribution_priority: type: string enum: - click - coupon_code description: Whether clicks or coupon codes take priority for attribution. accounting_contact_email: type: string description: Email address for accounting/billing contact. verification_token: type: string description: >- Verification token for postback security (max 50 alphanumeric characters). offer_id_macro: type: string description: Offer ID parameter name for Direct Linking. affiliate_id_macro: type: string description: Partner ID parameter name for Direct Linking. address_id: type: integer description: Address record ID. is_contact_address_enabled: type: boolean description: Whether a contact address is stored for this advertiser. is_expose_publisher_reporting_data: type: boolean nullable: true description: Whether publisher reporting data is exposed to this advertiser. contact_address: type: object writeOnly: true description: Contact address. Only used in create/update requests. properties: address_1: type: string address_2: type: string city: type: string region_code: type: string country_code: type: string zip_postal_code: type: string labels: type: array writeOnly: true description: >- Labels to assign. Only used in create/update requests. Use the relationship object to read labels. items: type: string time_created: type: integer example: 1734455015 description: Unix timestamp when the advertiser was created. time_saved: type: integer example: 1734455015 description: Unix timestamp when the advertiser was last updated. relationship: type: object description: Related data (only present when requested via query parameter). properties: labels: type: object description: Labels assigned to this advertiser. properties: total: type: integer description: Total number of labels. entries: type: array description: List of label strings. items: type: string users: type: object description: User accounts associated with this advertiser. properties: total: type: integer entries: type: array items: type: object properties: network_advertiser_user_id: type: integer description: Unique user ID. network_id: type: integer description: Network ID. network_advertiser_id: type: integer description: Advertiser ID this user belongs to. first_name: type: string description: User's first name. last_name: type: string description: User's last name. email: type: string description: User's email address. title: type: string description: User's title. account_status: type: string enum: - active - inactive description: User's account status. work_phone: type: string description: Work phone number. cell_phone: type: string description: Cell phone number. instant_messaging_id: type: integer description: Instant messaging platform ID. instant_messaging_identifier: type: string description: Instant messaging handle. language_id: type: integer description: Language ID. timezone_id: type: integer description: Timezone ID. currency_id: type: string description: ISO currency code. time_created: type: integer example: 1734455015 description: Unix timestamp of creation. time_saved: type: integer example: 1734455015 description: Unix timestamp of last update. account_manager: type: object properties: first_name: type: string last_name: type: string email: type: string work_phone: type: string cell_phone: type: string instant_messaging_id: type: integer description: >- The ID of an instant messaging platform. Allows you to save the user's identifier for further reference. instant_messaging_identifier: type: string description: Username or handle for the messaging platform. sale_manager: type: object properties: first_name: type: string last_name: type: string email: type: string work_phone: type: string cell_phone: type: string instant_messaging_id: type: integer description: >- The ID of an instant messaging platform. Allows you to save the user's identifier for further reference. instant_messaging_identifier: type: string description: Username or handle for the messaging platform. reporting: type: object description: >- Reporting metrics for this advertiser (only present when requested via `?relationship=reporting`). properties: gross_click: type: integer description: Total gross clicks (including invalid). total_click: type: integer description: Total valid clicks. unique_click: type: integer description: Unique clicks. duplicate_click: type: integer description: Duplicate clicks. invalid_click: type: integer description: Invalid or flagged clicks. cv: type: integer description: Conversions. total_cv: type: integer description: Total conversions (including view-through). view_through_cv: type: integer description: View-through conversions. event: type: integer description: Total events. imp: type: integer description: Impressions. revenue: type: number format: double description: Total revenue. payout: type: number format: double description: Total payout. event_revenue: type: number format: double description: Revenue from events. profit: type: number format: double description: Total profit (revenue minus payout). margin: type: number format: double description: Profit margin percentage. media_buying_cost: type: number format: double description: Media buying cost. gross_sales: type: number format: double description: Gross sales amount. avg_sale_value: type: number format: double description: Average sale value. cpc: type: number format: double description: Cost per click. cpa: type: number format: double description: Cost per action. cpm: type: number format: double description: Cost per mille (thousand impressions). epc: type: number format: double description: Earnings per click. rpc: type: number format: double description: Revenue per click. rpa: type: number format: double description: Revenue per action. rpm: type: number format: double description: Revenue per mille. ctr: type: number format: double description: Click-through rate. cvr: type: number format: double description: Conversion rate. evr: type: number format: double description: Event rate. roas: type: number format: double description: Return on ad spend. invalid_cv_scrub: type: integer description: Scrubbed invalid conversions. on_hold_potential_revenue: type: number format: double description: Revenue from on-hold conversions. on_hold_potential_payout: type: number format: double description: Payout from on-hold conversions. on_hold_conversion_count: type: integer description: Number of on-hold conversions. public_events: type: integer description: Number of public events. billing: type: object description: >- Billing configuration (only present when requested via `?relationship=billing`). properties: network_id: type: integer description: Network ID. network_advertiser_id: type: integer description: Advertiser ID. billing_frequency: type: string enum: - weekly - bimonthly - monthly - two_months - quarterly - manual - other description: How often the advertiser is invoiced. invoice_amount_threshold: type: number format: double description: Minimum amount to trigger invoice generation. tax_id: type: string description: Tax ID / VAT or SSN. is_invoice_creation_auto: type: boolean description: Whether invoices are generated automatically. auto_invoice_start_date: type: string description: Start date for automatic invoicing. default_invoice_is_hidden: type: boolean description: Whether invoices are hidden from the advertiser. invoice_generation_days_delay: type: integer description: Days to wait after billing period before generating invoice. default_payment_terms: type: integer description: Payment terms in days. relationship: type: object description: >- Billing schedule details, keyed by frequency type (e.g. `monthly`, `weekly`). integrations: type: object description: >- Integration settings (only present when requested via `?relationship=integrations`). properties: advertiser_demand_partner: type: object description: Demand partner integration configuration. demand_partner: type: object description: Demand partner settings. contact_address: type: object description: Contact address on file for this advertiser. properties: address_id: type: integer description: Address record ID. network_id: type: integer description: Network ID. address_1: type: string description: Street address line 1. address_2: type: string description: Street address line 2. city: type: string description: City name. region_code: type: string description: State or region code (e.g. "CA"). country_id: type: integer description: Numeric country ID. country_code: type: string description: Two-letter country code (e.g. "US"). zip_postal_code: type: string description: ZIP or postal code. api_keys: type: object description: API keys associated with this advertiser. properties: total: type: integer description: Total number of API keys. entries: type: array items: type: object properties: network_api_key_id: type: integer description: Unique API key record ID. network_id: type: integer description: Network ID. resource_id: type: integer description: Resource ID this key is associated with. api_key: type: string description: The API key string. resource_type: type: string description: Type of resource (e.g. "advertiser"). key_status: type: string enum: - active - revoked description: Current status of the API key. network_employee_id: type: integer description: Employee who created the key. time_created: type: integer example: 1734455015 description: Unix timestamp of creation. time_saved: type: integer example: 1734455015 description: Unix timestamp of last update. modules: type: object nullable: true description: API modules this key has access to. api_key_name: type: string description: Display name for the API key. relationship_modules: type: object nullable: true description: Related module permissions. relationship_resource: type: object nullable: true description: Related resource details. last_usage: type: integer description: Unix timestamp of last usage. api_key_hash: type: string description: Hash of the API key. api_whitelist_ips: type: object description: Whitelisted IP addresses for API access. properties: total: type: integer entries: type: array items: type: object settings: type: object description: >- Advertiser-specific settings (only present when requested via `?relationship=settings`). properties: network_id: type: integer description: Network ID. network_advertiser_id: type: integer description: Advertiser ID. exposed_variables: type: object description: >- Controls which tracking variables are visible to this advertiser in reporting. properties: affiliate_id: type: boolean description: Whether the affiliate ID is exposed. affiliate: type: boolean description: Whether the affiliate name is exposed. sub1: type: boolean description: Whether sub-parameter 1 is exposed. sub2: type: boolean description: Whether sub-parameter 2 is exposed. sub3: type: boolean description: Whether sub-parameter 3 is exposed. sub4: type: boolean description: Whether sub-parameter 4 is exposed. sub5: type: boolean description: Whether sub-parameter 5 is exposed. sub6: type: boolean description: Whether sub-parameter 6 is exposed. sub7: type: boolean description: Whether sub-parameter 7 is exposed. sub8: type: boolean description: Whether sub-parameter 8 is exposed. sub9: type: boolean description: Whether sub-parameter 9 is exposed. sub10: type: boolean description: Whether sub-parameter 10 is exposed. source_id: type: boolean description: Whether the source ID is exposed. offer_url: type: boolean description: Whether the offer URL is exposed. time_saved: type: integer description: Unix timestamp of last update. product_feeds: type: array description: >- Product feeds configured for this advertiser (only present when requested via `?relationship=product_feed`). items: type: object properties: network_advertiser_product_feed_id: type: integer description: Unique product feed ID. network_id: type: integer description: Network ID. network_advertiser_id: type: integer description: Advertiser ID. name: type: string description: Product feed name. status: type: string description: Feed status (e.g. "active"). apply_to_all_affiliates: type: boolean description: Whether this feed applies to all affiliates. affiliate_ids: type: array items: type: integer description: Specific affiliate IDs this feed applies to. offer_ids: type: array items: type: integer description: Offer IDs associated with this feed. file_asset_id: type: integer description: Uploaded file asset ID. date_valid_from: type: integer description: Unix timestamp of validity start. date_valid_to: type: integer description: Unix timestamp of validity end. date_valid_timezone_id: type: integer description: Timezone ID for validity dates. document_file: type: string description: Document file URL or path. time_saved: type: integer example: 1734455015 description: Unix timestamp of last update. time_created: type: integer example: 1734455015 description: Unix timestamp of creation. deals: type: array description: >- Deals configured for this advertiser (only present when requested via `?relationship=deal`). items: type: object properties: network_advertiser_deal_id: type: integer description: Unique deal ID. network_id: type: integer description: Network ID. network_advertiser_id: type: integer description: Advertiser ID. name: type: string description: Deal name. deal_type: type: string description: Type of deal. deal_status: type: string description: Current deal status. deal_categories: type: array items: type: string description: Categories associated with this deal. description: type: string description: Deal description. restrictions: type: string description: Deal restrictions or terms. scope: type: string description: Deal scope. coupon_code: type: string description: Coupon code for this deal. coupon_code_discount_percentage: type: number description: Discount percentage applied by the coupon. coupon_code_discount_amount: type: number description: Fixed discount amount applied by the coupon. coupon_code_discount_currency_id: type: string description: Currency for the discount amount. threshold_quantity: type: integer description: Minimum quantity threshold to trigger the deal. threshold_amount: type: number description: Minimum spend threshold to trigger the deal. threshold_amount_currency_id: type: string description: Currency for the threshold amount. purchase_limit_quantity: type: integer description: Maximum purchase quantity. purchase_limit_amount: type: number description: Maximum purchase amount. purchase_limit_amount_currency_id: type: string description: Currency for the purchase limit. apply_to_all_affiliates: type: boolean description: Whether this deal applies to all affiliates. affiliate_ids: type: array items: type: integer description: Specific affiliate IDs this deal applies to. offer_ids: type: array items: type: integer description: Offer IDs associated with this deal. date_valid_from: type: integer description: Unix timestamp of validity start. date_valid_to: type: integer description: Unix timestamp of validity end. date_valid_timezone_id: type: integer description: Timezone ID for validity dates. brand_name: type: string description: Brand name associated with this deal. time_saved: type: integer description: Unix timestamp of last update. time_created: type: integer description: Unix timestamp of creation. time_deleted: type: integer description: Unix timestamp of deletion (0 if not deleted). securitySchemes: API Key: description: The Everflow API key generated from the Control Center > Security. in: header name: X-Eflow-Api-Key type: apiKey ````