> ## 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 Affiliate by ID Retrieve a single affiliate by its ID. Use the `relationship` query parameter to include related data such as users, signup, billing, coupon\_codes, visibility, reporting, and more. ## OpenAPI ````yaml openapi/affiliates.yaml get /networks/affiliates/{affiliateId} openapi: 3.0.3 info: title: Everflow Network API - Affiliates description: > Affiliate management endpoints for the Everflow partner marketing platform. Search, retrieve, create, and update affiliate accounts. To learn more about partners, see the [Partner overview](https://helpdesk.everflow.io/customer/who-is-a-partner-in-everflow). version: 1.0.0 servers: - description: Production Server url: https://api.eflow.team/v1 security: [] tags: - name: Affiliates description: Endpoints for searching and managing affiliates. paths: /networks/affiliates/{affiliateId}: get: tags: - Affiliates summary: Get Affiliate by ID parameters: - in: path name: affiliateId required: true schema: type: integer description: The unique affiliate ID. - in: query name: relationship schema: type: string enum: - reporting - billing - coupon_codes - users - audits - visibility - signup - api - traffic_source - referral_link - referrer - referral - supply_partner description: Include related data. Repeat for multiple relationships. responses: '200': description: '' content: application/json: example: network_affiliate_id: 7 network_id: 1 name: Some Agency Inc. account_status: active network_employee_id: 2 internal_notes: '' has_notifications: false network_traffic_source_id: 0 account_executive_id: 0 adress_id: 0 default_currency_id: USD is_contact_address_enabled: false enable_media_cost_tracking_links: true time_created: 1664825245 time_saved: 1664825245 referrer_id: 0 relationship: labels: total: 0 entries: [] users: total: 1 entries: - network_affiliate_user_id: 11 network_id: 1 network_affiliate_id: 7 first_name: Bob last_name: Smith email: bob.smith@example.com title: '' work_phone: '4858555836' cell_phone: '' instant_messaging_id: 0 instant_messaging_identifier: '' language_id: 1 timezone_id: 75 currency_id: USD account_status: active time_created: 1664825245 time_saved: 1664825245 account_manager: first_name: John last_name: Doe email: john.doe@example.com work_phone: '9781243585' cell_phone: '' instant_messaging_id: 0 instant_messaging_identifier: '' encoded_value: 9W598 billing: network_id: 1 network_affiliate_id: 7 billing_frequency: weekly payment_type: none invoice_amount_threshold: 0 tax_id: '' is_invoice_creation_auto: false auto_invoice_start_date: '2019-03-01 00:00:00' default_invoice_is_hidden: false invoice_generation_days_delay: 0 default_payment_terms: 0 is_automated_payment_enabled: false vat_percentage: 0 relationship: weekly: day_of_week: 4 is_payable: true api_keys: total: 0 entries: [] api_whitelist_ips: total: 0 entries: [] ios_app_sources: total: 0 entries: [] schema: type: object properties: network_affiliate_id: type: integer description: Unique affiliate ID. network_id: type: integer description: Network ID. name: type: string description: Affiliate name. account_status: type: string enum: - active - inactive - pending - suspended description: Current account status. network_employee_id: type: integer description: Account manager employee ID. internal_notes: type: string description: >- Internal notes about this affiliate (not visible to the affiliate). default_currency_id: type: string description: ISO currency code for the affiliate's default currency. enable_media_cost_tracking_links: type: boolean description: >- Whether media cost tracking is enabled on this affiliate's links. is_contact_address_enabled: type: boolean description: Whether a contact address is stored for this affiliate. has_notifications: type: boolean description: Whether notifications are enabled. network_traffic_source_id: type: integer description: Associated traffic source ID. account_executive_id: type: integer description: Account executive employee ID. adress_id: type: integer description: >- Address record ID. Note the field name uses a single 'd' (`adress_id`) in the API response. referrer_id: type: integer description: ID of the referring affiliate, if any. time_created: type: integer example: 1734455015 description: Unix timestamp of creation. time_saved: type: integer example: 1734455015 description: Unix timestamp of last update. relationship: type: object description: >- Related data (only present when requested via the `relationship` query parameter). properties: labels: type: object description: Labels associated with this affiliate. properties: total: type: integer description: Total number of labels. entries: type: array description: List of label strings. items: type: string description: A label string. account_manager: type: object description: Account manager details. properties: first_name: type: string description: Account manager's first name. last_name: type: string description: Account manager's last name. email: type: string description: Account manager's email address. work_phone: type: string description: Account manager's work phone number. cell_phone: type: string description: Account manager's cell phone number. instant_messaging_id: type: integer description: Account manager's instant messaging platform ID. instant_messaging_identifier: type: string description: Account manager's instant messaging identifier. encoded_value: type: string description: Encoded tracking value for this affiliate. network_affiliate_tier_id: type: integer description: The affiliate tier this affiliate belongs to. reporting: type: object description: >- Reporting metrics for the affiliate (requires `reporting` relationship). properties: imp: type: integer description: Total impressions. total_click: type: integer description: Total clicks. unique_click: type: integer description: Unique clicks. invalid_click: type: integer description: Invalid (flagged) clicks. duplicate_click: type: integer description: Duplicate clicks. gross_click: type: integer description: Gross clicks (total + invalid + duplicate). ctr: type: number description: Click-through rate. cv: type: integer description: Conversions. invalid_cv_scrub: type: integer description: Invalid conversions (scrubbed). view_through_cv: type: integer description: View-through conversions. total_cv: type: integer description: Total conversions. event: type: integer description: Total events. cvr: type: number description: Conversion rate. evr: type: number description: Event rate. cpc: type: number description: Cost per click. cpm: type: number description: Cost per mille (thousand impressions). cpa: type: number description: Cost per acquisition. epc: type: number description: Earnings per click. rpc: type: number description: Revenue per click. rpa: type: number description: Revenue per acquisition. rpm: type: number description: Revenue per mille. payout: type: number description: Total payout amount. revenue: type: number description: Total revenue. event_revenue: type: number description: Revenue from events. gross_sales: type: number description: Gross sales amount. profit: type: number description: Net profit (revenue minus payout). margin: type: number description: Profit margin percentage. roas: type: number description: Return on ad spend. avg_sale_value: type: number description: Average sale value. media_buying_cost: type: number description: Media buying cost. on_hold_potential_revenue: type: number description: Potential revenue from on-hold conversions. on_hold_potential_payout: type: number description: Potential 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 and invoicing information (requires `billing` relationship). properties: network_id: type: integer description: Network ID. network_affiliate_id: type: integer description: Affiliate ID. billing_frequency: type: string description: Invoicing frequency. enum: - weekly - bimonthly - monthly - two_months - quarterly - manual - other payment_type: type: string description: Payment method type. invoice_amount_threshold: type: number description: Minimum amount for invoice generation. tax_id: type: string description: Tax ID. is_invoice_creation_auto: type: boolean description: Whether invoices are generated automatically. auto_invoice_start_date: type: string description: Automatic invoice creation start date. default_invoice_is_hidden: type: boolean description: >- Whether invoices are hidden from the affiliate by default. invoice_generation_days_delay: type: integer description: >- Days to wait after billing period for invoice generation. default_payment_terms: type: integer description: Default payment terms in days. is_automated_payment_enabled: type: boolean description: Whether automated payment is enabled. vat_percentage: type: number description: VAT percentage applied to invoices. is_payable: type: boolean description: Whether the affiliate is payable. relationship: type: object description: >- Billing frequency details (weekly, bimonthly, monthly, etc.). coupon_codes: type: object description: >- Coupon codes associated with this affiliate (requires `coupon_codes` relationship). properties: total: type: integer description: Total number of coupon codes. entries: type: array description: List of coupon code records. items: type: object description: A coupon code record. users: type: object description: >- User accounts associated with this affiliate (requires `users` relationship). properties: total: type: integer description: Total number of users. entries: type: array description: List of user records. items: type: object description: An affiliate user record. audits: type: object description: >- Revision history of changes (requires `audits` relationship). properties: total: type: integer description: Total number of audit records. entries: type: array description: List of audit records. items: type: object description: An audit record. visible_offers: type: object description: >- Offers visible to this affiliate (requires `visibility` relationship). properties: total: type: integer description: Total number of visible offers. entries: type: array description: List of visible offer records. items: type: object description: An offer record. hidden_offers: type: object description: >- Offers hidden from this affiliate (requires `visibility` relationship). properties: total: type: integer description: Total number of hidden offers. entries: type: array description: List of hidden offer records. items: type: object description: An offer record. rejected_offers: type: object description: >- Offers rejected for this affiliate (requires `visibility` relationship). properties: total: type: integer description: Total number of rejected offers. entries: type: array description: List of rejected offer records. items: type: object description: An offer record. api_keys: type: object description: >- API keys for this affiliate (requires `api` relationship). properties: total: type: integer description: Total number of API keys. entries: type: array description: List of API key records. items: type: object description: An API key record. api_whitelist_ips: type: object description: >- Whitelisted IPs for API access (requires `api` relationship). properties: total: type: integer description: Total number of whitelisted IPs. entries: type: array description: List of whitelisted IP records. items: type: object description: An API whitelist IP record. ios_app_sources: type: object description: iOS app sources associated with this affiliate. properties: total: type: integer description: Total number of iOS app source records. entries: type: array description: List of iOS app source records. items: type: object description: An iOS app source record. '404': description: Affiliate not found. security: - API Key: [] components: securitySchemes: API Key: description: The Everflow API key generated from the Control Center > Security. in: header name: X-Eflow-Api-Key type: apiKey ````