# List partners

Retrieves a list of partners, filterable by ID or type.

Endpoint: GET /v0/collections/partners
Version: 0.0.1
Security: Bearer

## Query parameters:

  - `id` (string)
    Filter partners by specific partner ID
    Example: "0c5479ff-3772-4123-b2b7-e679e71eb570"

  - `since` (string)
    ISO 8601 timestamp after partner was created
    Example: "2025-06-17T12:00:00Z"

  - `until` (string)
    ISO 8601 timestamp before partner was created
    Example: "2025-06-17T12:00:00Z"

  - `type` (string)
    Filter partners by type
    Enum: "BUSINESS", "INDIVIDUAL"

  - `status` (string)
    Filter partners by status
    Enum: "PENDING", "ON_HOLD", "FAILED", "ACTIVATED", "DEACTIVATED"

  - `external_reference_id` (string)
    External reference id for partner
    Example: "Ref-123"

  - `page` (integer)
    Page number (starts at 1)
    Example: 1

  - `size` (integer)
    Page size (items per page)
    Example: 10

## Response 200 fields (application/json):

  - `content` (array)

  - `content.id` (string, required)
    Unique identifier for the partner
    Example: "0c5479ff-3772-4123-b2b7-e679e71eb570"

  - `content.name` (string, required)
    Full name of the partner organization or individual
    Example: "Nigerian Imports Ltd."

  - `content.email` (string, required)
    Email address for partner communications
    Example: "nigerian@imports.com"

  - `content.external_reference_id` (string)
    External reference id for partner
    Example: "Ref-123"

  - `content.data` (object) — one of (discriminator: type):
    - BUSINESS:
      - `type` (string, required)
        Discriminator: indicates this is business metadata
        Enum: "BUSINESS"
      - `legal_entity` (string, required)
        Legal name of the business entity
        Example: "Nigerian Imports Ltd."
      - `registration_number` (string, required)
        Business registration number
        Example: "RC-123456-NGR"
      - `registration_type` (string, required)
        Business registration/identification type
        Enum: "AIIN", "BANK", "BOID", "CBID", "CHID", "CINC", "COID", "CUST", "DUNS", "EMPL", "GS1G", "SREN", "SRET", "TXID", "USCC"
      - `country` (string, required)
        Country where the business is registered
        Example: "NG"
      - `city` (string)
        City where the business is located
        Example: "Lagos Island"
      - `postal_code` (string)
        Postal code of the business address
        Example: "10010"
      - `address` (string, required)
        Primary address of the business
        Example: "15 Marina Street"
      - `address_line_2` (string)
        Secondary address line
        Example: "Suite 200"
    - INDIVIDUAL:
      - `type` (string, required)
        Discriminator: indicates this is individual metadata
        Enum: "INDIVIDUAL"
      - `first_name` (string, required)
        First name of the individual
        Example: "John"
      - `last_name` (string, required)
        Last name of the individual
        Example: "Doe"
      - `date_of_birth` (string, required)
        Date of birth of the individual
        Example: "1990-05-15"
      - `identification_number` (string, required)
        Identification number of the individual
      - `identification_type` (string, required)
        Identification type for the individual identifier
        Enum: "AIIN", "ARNU", "CCPT", "DRLC", "NIDN", "POID", "SOS", "TXID"
      - `country` (string, required)
        Country of residence
        Example: "United States"
      - `city` (string)
        City of residence
        Example: "New York"
      - `postal_code` (string)
        Postal code of residence
        Example: "10001"
      - `address` (string, required)
        Primary address of residence
        Example: "123 Main Street"
      - `address_line_2` (string)
        Secondary address line
        Example: "Suite 200"

  - `content.status` (string, required)
    Partner status for collection links or channels
    Enum: same as `status` (5 values)

  - `content.reason` (string,null)
    Reason for current status (if applicable)

  - `content.created_at` (string, required)
    Timestamp when the partner was created
    Example: "2025-09-18T22:54:00.542Z"

  - `content.updated_at` (string, required)
    Timestamp when the partner was last updated
    Example: "2025-09-18T23:54:00.542Z"

  - `page` (object)
    Pagination metadata.

  - `page.page` (integer, required)
    Example: 1

  - `page.size` (integer, required)
    Example: 10

  - `page.total_elements` (integer, required)
    Example: 100

  - `page.total_pages` (integer, required)
    Example: 10

## Response 400 fields (application/json):

  - `code` (string, required)
    Error code identifying the type of error

  - `reason` (string, required)
    Human-readable error message