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

  - `content.status` (string, required)
    Partner status for collection links or channels
    Enum: "PENDING", "ON_HOLD", "FAILED", "ACTIVATED", "DEACTIVATED"

  - `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