> ## 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.

# List Affiliate Users

Retrieve all users for a specific affiliate. Returns user details including contact information, roles, and primary user designation.


## OpenAPI

````yaml openapi/affiliate-users.yaml get /networks/affiliates/{affiliateId}/users
openapi: 3.0.3
info:
  title: Everflow Network API - Affiliate Users
  description: >
    Endpoints for managing affiliate (partner) user accounts from the network
    level. Affiliate users are individual people who belong to a partner
    account. Networks can create, update, and retrieve these users to control
    who has access to the partner portal.
  version: 1.0.0
servers:
  - url: https://api.eflow.team/v1
security: []
tags:
  - name: Affiliate Users
paths:
  /networks/affiliates/{affiliateId}/users:
    get:
      tags:
        - Affiliate Users
      summary: List Affiliate Users
      parameters:
        - in: path
          name: affiliateId
          required: true
          schema:
            type: integer
          description: The ID of the affiliate whose users you want to fetch.
        - in: query
          name: relationship
          required: false
          schema:
            type: string
            enum:
              - logins
              - password_history
              - api
              - affiliate_status
              - customizations
          description: >
            Include additional related data in the response. Multiple
            relationships can be supplied by repeating the `relationship` query
            parameter. Supported values: `logins` (includes the users' list of
            logins), `password_history` (includes the users' password changes
            history), `api` (includes the users' API key and whitelisted IPs),
            `affiliate_status` (includes the status of the affiliate to which
            the user belongs), `customizations` (includes the users'
            customizations).
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  users:
                    type: array
                    description: List of affiliate users.
                    items:
                      $ref: '#/components/schemas/AffiliateUser'
              example:
                users:
                  - network_affiliate_user_id: 17
                    network_id: 1
                    network_affiliate_id: 1
                    first_name: Bob
                    last_name: Smith
                    email: my.everflow@gmail.com
                    title: ''
                    work_phone: '9655433513'
                    cell_phone: ''
                    instant_messaging_id: 0
                    instant_messaging_identifier: ''
                    language_id: 1
                    timezone_id: 75
                    currency_id: USD
                    account_status: active
                    relationship:
                      affiliate_account_status: active
      security:
        - API Key: []
components:
  schemas:
    AffiliateUser:
      type: object
      properties:
        network_affiliate_user_id:
          type: integer
          description: Unique affiliate user ID.
        network_id:
          type: integer
          description: The network ID this user belongs to.
        network_affiliate_id:
          type: integer
          description: The affiliate ID this user belongs to.
        first_name:
          type: string
          description: The affiliate user's first name.
        last_name:
          type: string
          description: The affiliate user's last name.
        email:
          type: string
          description: The affiliate user's email address. Is used to log in the platform.
        title:
          type: string
          description: The affiliate user's title.
        work_phone:
          type: string
          description: The affiliate user's work phone number.
        cell_phone:
          type: string
          description: The affiliate user's cell phone number.
        instant_messaging_id:
          type: integer
          description: The ID of an instant messaging platform.
        instant_messaging_identifier:
          type: string
          description: The affiliate user's instant messaging identifier.
        language_id:
          type: integer
          description: The affiliate user's language ID.
        timezone_id:
          type: integer
          description: The affiliate user's timezone ID.
        currency_id:
          type: string
          description: The affiliate user's currency ID.
        account_status:
          type: string
          enum:
            - active
            - inactive
          description: >-
            The affiliate user's account status. Can be either `active` or
            `inactive`.
        relationship:
          type: object
          nullable: true
          description: >
            Related data for this affiliate user. Populate by passing
            `relationship` query parameters (e.g.
            `?relationship=logins&relationship=api`).
          properties:
            logins:
              type: object
              description: Login history for this user.
              properties:
                total:
                  type: integer
                  description: Total number of login records.
                entries:
                  type: array
                  description: List of login records.
                  items:
                    type: object
            customization:
              type: object
              description: User customization settings.
            audits:
              type: object
              description: Audit history for this user.
              properties:
                total:
                  type: integer
                  description: Total number of audit records.
                entries:
                  type: array
                  description: List of audit records.
                  items:
                    type: object
            api:
              type: object
              description: API key and whitelisted IPs for this user.
              properties:
                total:
                  type: integer
                  description: Total number of API key records.
                entries:
                  type: array
                  description: List of API key records.
                  items:
                    type: object
            affiliate_account_status:
              type: string
              description: >
                The account status of the affiliate this user belongs to. Always
                included in the response, even without requesting the
                `affiliate_status` relationship.
        time_created:
          type: integer
          example: 1734455015
          description: Unix timestamp of when the user was created.
        time_saved:
          type: integer
          example: 1734455015
          description: Unix timestamp of when the user was last updated.
  securitySchemes:
    API Key:
      description: The Everflow API key generated from the Control Center > Security.
      in: header
      name: X-Eflow-Api-Key
      type: apiKey

````