> ## Documentation Index
> Fetch the complete documentation index at: https://docs.younegotiate.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get import creditor profile options

> Return the creditor profile CSV header checklist and upload constraints used by the Import Creditor Profiles upload screen.



## OpenAPI

````yaml /api/ecomailhub.openapi.yaml get /import-creditor-profiles/options
openapi: 3.1.0
info:
  title: YouNegotiate EcoMail Hub API
  version: '2.0'
  description: Stateless API endpoints for EcoMail Hub / EcoPortal users.
servers:
  - url: https://api.ecomailhub.younegotiate.com
    description: Production
security: []
tags:
  - name: System
    description: Public EcoMail Hub domain system and health endpoints.
  - name: Authentication
    description: EcoMail Hub login, logout, password reset, and password change endpoints.
  - name: Profile
    description: Authenticated EcoMail Hub user profile endpoints.
  - name: Dashboard
    description: EcoMail Hub dashboard summary and notice-response bucket endpoints.
  - name: Manage Consumers
    description: >-
      EcoMail Hub consumer identity grouping and notice-response count
      endpoints.
  - name: Manage Creditors
    description: >-
      EcoMail Hub creditor profile and company-only member profile table
      endpoints.
  - name: Import Creditor Profiles
    description: EcoMail Hub creditor profile CSV import endpoints.
  - name: Manage Notice Response
    description: >-
      EcoMail Hub top-level notice-response review, reassignment, and close
      endpoints.
  - name: Manage Users
    description: EcoMail Hub user account management endpoints.
  - name: Reports
    description: EcoMail Hub one-time and scheduled CSV report endpoints.
  - name: Communications
    description: EcoMail Hub communication template editor endpoints.
paths:
  /import-creditor-profiles/options:
    get:
      tags:
        - Import Creditor Profiles
      summary: Get import creditor profile options
      description: >-
        Return the creditor profile CSV header checklist and upload constraints
        used by the Import Creditor Profiles upload screen.
      operationId: ecomailhubCreditorProfileImportOptions
      responses:
        '200':
          description: Import creditor profile options returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditorProfileImportOptionsResponse'
              example:
                data:
                  fields:
                    - value: company_name
                      header: Company Name
                      required: true
                    - value: contact_1_first_name
                      header: Contact 1 First Name
                      required: false
                  expected_headers:
                    - Company Name
                    - Company Address 1
                    - Company Address 2
                    - City
                    - State
                    - Zip
                    - Phone
                    - URL
                    - Company Email
                    - Passthrough
                    - Contact 1 First Name
                    - Contact 1 Last Name
                    - Contact 1 Email
                    - Contact 1 Phone
                    - Contact 2 First Name
                    - Contact 2 Last Name
                    - Contact 2 Email
                    - Contact 2 Phone
                    - Contact 3 First Name
                    - Contact 3 Last Name
                    - Contact 3 Email
                    - Contact 3 Phone
                  required_headers:
                    - Company Name
                    - Company Address 1
                    - City
                    - State
                    - Zip
                    - Phone
                    - URL
                    - Company Email
                  upload:
                    max_size_bytes: 104857600
                    max_size_mb: 100
                    accepted_extensions:
                      - csv
                    accepted_mime_types:
                      - text/csv
                      - text/plain
                      - application/csv
                      - text/comma-separated-values
                      - application/vnd.ms-excel
                      - application/octet-stream
        '401':
          $ref: '#/components/responses/Unauthenticated'
      security:
        - bearerAuth: []
components:
  schemas:
    CreditorProfileImportOptionsResponse:
      type: object
      required:
        - data
      properties:
        data:
          type: object
          required:
            - fields
            - expected_headers
            - required_headers
            - upload
          properties:
            fields:
              type: array
              items:
                $ref: '#/components/schemas/CreditorProfileImportFieldOption'
            expected_headers:
              type: array
              items:
                type: string
              description: CSV headers the backend expects before queueing the import.
            required_headers:
              type: array
              items:
                type: string
              description: Headers whose row values are required during import validation.
            upload:
              type: object
              required:
                - max_size_bytes
                - max_size_mb
                - accepted_extensions
                - accepted_mime_types
              properties:
                max_size_bytes:
                  type: integer
                  example: 104857600
                max_size_mb:
                  type: integer
                  example: 100
                accepted_extensions:
                  type: array
                  items:
                    type: string
                  example:
                    - csv
                accepted_mime_types:
                  type: array
                  items:
                    type: string
                  example:
                    - text/csv
                    - text/plain
                    - application/csv
                    - text/comma-separated-values
                    - application/vnd.ms-excel
                    - application/octet-stream
    CreditorProfileImportFieldOption:
      type: object
      required:
        - value
        - header
        - required
      properties:
        value:
          type: string
          example: company_name
        header:
          type: string
          example: Company Name
        required:
          type: boolean
          example: true
    MessageResponse:
      type: object
      required:
        - message
      properties:
        message:
          type: string
  responses:
    Unauthenticated:
      description: Missing or invalid bearer token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/MessageResponse'
          example:
            message: Unauthenticated.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Sanctum

````