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

# List Partners



## OpenAPI

````yaml https://app.amber.ai/api/public/v1/openapi.json get /brands/{brand}/partners
openapi: 3.1.0
info:
  title: Amber Public API
  version: 1.3.0
  description: >-
    Read-only access to brand business data. Products are Parent Products;
    Product Options and SKUs are distinct resources. Follow reference IDs and
    collection cursors for complete graphs. API keys never impersonate their
    creator. New source monetary values are decimal strings; deployed summary
    numbers remain unchanged. JSON specifications retain all nested fields.
    Archived rows remain visible unless soft-deleted; supplier-private quote
    drafts are excluded.
servers:
  - url: https://app.amber.ai/api/public/v1
security: []
tags:
  - name: Brand
  - name: Parent Products
  - name: Product Options
  - name: SKUs
  - name: Product Versions
  - name: Boms
  - name: Bom Components
  - name: Bom Skus
  - name: Measurement Tables
  - name: Measurement Table Skus
  - name: Product Relations
  - name: Product Option Values
  - name: Product Option Dimension Values
  - name: Product Option Prices
  - name: Product Option Collections
  - name: Sku Dimension Values
  - name: Product Collections
  - name: Product Tags
  - name: Product Launch Windows
  - name: Suppliers
  - name: Quotes
  - name: Quote Revisions
  - name: Quote Items
  - name: Quote Price Bands
  - name: Quote Notes
  - name: Samples
  - name: Sample Rounds
  - name: Sample Checklist Results
  - name: Orders
  - name: Order Items
  - name: Order Amendments
  - name: Production Runs
  - name: Production Run Items
  - name: Production Run Item Revisions
  - name: Shipments
  - name: Shipment Items
  - name: Shipment Cartons
  - name: Shipment Carton Items
  - name: Shipment Charges
  - name: Order Shipments
  - name: Legs
  - name: Leg Items
  - name: Bookings
  - name: Booking Items
  - name: Shipment Bookings
  - name: Shipment Item Lineages
  - name: Packing Lists
  - name: Packing List Lines
  - name: Goods Receipts
  - name: Goods Receipt Lines
  - name: Inventory
  - name: Invoices
  - name: Invoice Lines
  - name: Payment Agreements
  - name: Payment Milestones
  - name: Payments
  - name: Payment Settlements
  - name: Payment Receipts
  - name: Partners
  - name: Contacts
  - name: Locations
  - name: Brand Locations
  - name: Partner Locations
  - name: Documents
  - name: Document Types
  - name: Images
  - name: Notes
  - name: Materials
  - name: Material Variants
  - name: Bom Sections
  - name: Categories
  - name: Collections
  - name: Launch Windows
  - name: Tags
  - name: Colors
  - name: Options
  - name: Option Values
  - name: Dimensions
  - name: Dimension Values
  - name: Dimension Groups
  - name: Dimension Group Dimensions
  - name: Dimension Curves
  - name: Dimension Curve Axes
  - name: Dimension Curve Axis Values
  - name: Dimension Curve Cells
  - name: Checklists
  - name: Packing Templates
  - name: Carton Sizes
  - name: Couriers
  - name: Payment Terms
  - name: Units Of Measure
  - name: Countries
  - name: Custom Field Definitions
paths:
  /brands/{brand}/partners:
    get:
      tags:
        - Partners
      summary: List Partners
      operationId: listPartners
      parameters:
        - name: brand
          in: path
          required: true
          description: Brand slug authorized by this API key.
          schema:
            type: string
            example: acme
        - name: cursor
          in: query
          required: false
          description: >-
            Opaque nextCursor from the same collection and filters. Omit on the
            first request.
          schema:
            type: string
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
        - name: slug
          in: query
          required: false
          description: Exact, case-sensitive match. Spaces and punctuation are literal.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Exact, case-sensitive match. Spaces and punctuation are literal.
        - name: name
          in: query
          required: false
          description: Exact, case-sensitive match. Spaces and punctuation are literal.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Exact, case-sensitive match. Spaces and punctuation are literal.
        - name: shortName
          in: query
          required: false
          description: Exact, case-sensitive match. Spaces and punctuation are literal.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Exact, case-sensitive match. Spaces and punctuation are literal.
        - name: countryCode
          in: query
          required: false
          description: Exact, case-sensitive match. Spaces and punctuation are literal.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Exact, case-sensitive match. Spaces and punctuation are literal.
        - name: midCode
          in: query
          required: false
          description: Exact, case-sensitive match. Spaces and punctuation are literal.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Exact, case-sensitive match. Spaces and punctuation are literal.
        - name: businessRegistrationNumber
          in: query
          required: false
          description: Exact, case-sensitive match. Spaces and punctuation are literal.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Exact, case-sensitive match. Spaces and punctuation are literal.
        - name: taxId
          in: query
          required: false
          description: Exact, case-sensitive match. Spaces and punctuation are literal.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Exact, case-sensitive match. Spaces and punctuation are literal.
        - name: partnerStatus
          in: query
          required: false
          description: Exact, case-sensitive match. Spaces and punctuation are literal.
          schema:
            type: string
            minLength: 1
            maxLength: 255
            description: Exact, case-sensitive match. Spaces and punctuation are literal.
      responses:
        '200':
          description: >-
            One page. totalItems counts the full filtered set; nextCursor null
            means exhausted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnersList'
          headers:
            Link:
              description: >-
                Origin-relative URL for the next page, with rel="next". Resolve
                against this response URL. Preserves filters and page size;
                omitted when nextCursor is null.
              schema:
                type: string
        '400':
          description: >-
            Invalid parameter, unsupported include, or cursor used with
            different filters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid, expired, or out-of-scope API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Entity or related subject is not visible in this brand.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate limit exceeded. Retry after the indicated delay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            Retry-After:
              description: Seconds before retrying.
              schema:
                type: integer
                minimum: 0
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    PartnersList:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              slug:
                type: string
              name:
                type: string
              shortName:
                type:
                  - string
                  - 'null'
              countryCode:
                type:
                  - string
                  - 'null'
              defaultCurrencyCode:
                type:
                  - string
                  - 'null'
              leadTimeDays:
                type:
                  - number
                  - 'null'
              moq:
                type:
                  - number
                  - 'null'
              moqByColor:
                type:
                  - number
                  - 'null'
              moqLastConfirmedAt:
                type:
                  - string
                  - 'null'
              midCode:
                type:
                  - string
                  - 'null'
              website:
                type:
                  - string
                  - 'null'
              businessRegistrationNumber:
                type:
                  - string
                  - 'null'
              taxId:
                type:
                  - string
                  - 'null'
              minimumOrderValue:
                type:
                  - string
                  - 'null'
              certifications:
                anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
              specializations:
                anyOf:
                  - type: array
                    items:
                      type: string
                  - type: 'null'
              productionCapacity:
                type:
                  - number
                  - 'null'
              productionCapacityUnit:
                type:
                  - string
                  - 'null'
              factoryAuditDate:
                type:
                  - string
                  - 'null'
              factoryAuditStatus:
                type:
                  - string
                  - 'null'
              partnerStatus:
                type: string
              lastContactDate:
                type:
                  - string
                  - 'null'
              nextContactDate:
                type:
                  - string
                  - 'null'
              notes:
                anyOf:
                  - bd383147-592b-4493-b29e-c759b1542e15
                  - type: 'null'
              equipmentTechnology:
                type:
                  - string
                  - 'null'
              packagingCapabilities:
                type:
                  - string
                  - 'null'
              verified:
                type: boolean
              createdAt:
                type: string
              updatedAt:
                type: string
              relationship:
                type: object
                properties:
                  id:
                    type: string
                  status:
                    type: string
                  brandNotes:
                    anyOf:
                      - d5644cf7-e70c-4992-bb52-14db65d42a76
                      - type: 'null'
                  defaultIncotermCode:
                    type:
                      - string
                      - 'null'
                  defaultCurrencyCode:
                    type:
                      - string
                      - 'null'
                  defaultPaymentTermId:
                    type:
                      - string
                      - 'null'
                  qualityRating:
                    type:
                      - string
                      - 'null'
                  ontimeRating:
                    type:
                      - string
                      - 'null'
                  responsivenessRating:
                    type:
                      - string
                      - 'null'
                  sustainabilityScore:
                    type:
                      - string
                      - 'null'
                  brandOwnerUserId:
                    type:
                      - string
                      - 'null'
                  customFields:
                    anyOf:
                      - 2178aa60-0175-4dbb-b5df-03acba0b83a1
                      - type: 'null'
                required:
                  - id
                  - status
                  - brandNotes
                  - defaultIncotermCode
                  - defaultCurrencyCode
                  - defaultPaymentTermId
                  - qualityRating
                  - ontimeRating
                  - responsivenessRating
                  - sustainabilityScore
                  - brandOwnerUserId
                  - customFields
                additionalProperties: false
            required:
              - id
              - slug
              - name
              - shortName
              - countryCode
              - defaultCurrencyCode
              - leadTimeDays
              - moq
              - moqByColor
              - moqLastConfirmedAt
              - midCode
              - website
              - businessRegistrationNumber
              - taxId
              - minimumOrderValue
              - certifications
              - specializations
              - productionCapacity
              - productionCapacityUnit
              - factoryAuditDate
              - factoryAuditStatus
              - partnerStatus
              - lastContactDate
              - nextContactDate
              - notes
              - equipmentTechnology
              - packagingCapabilities
              - verified
              - createdAt
              - updatedAt
              - relationship
            additionalProperties: false
        nextCursor:
          type:
            - string
            - 'null'
        totalItems:
          type: integer
          minimum: 0
          maximum: 9007199254740991
      required:
        - items
        - nextCursor
        - totalItems
      additionalProperties: false
      $defs:
        __schema0:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/PartnersList/$defs/__schema0'
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                $ref: '#/components/schemas/PartnersList/$defs/__schema0'
        __schema1:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/PartnersList/$defs/__schema1'
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                $ref: '#/components/schemas/PartnersList/$defs/__schema1'
        __schema2:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/PartnersList/$defs/__schema2'
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                $ref: '#/components/schemas/PartnersList/$defs/__schema2'
    Error:
      type: object
      properties:
        error:
          type: string
        errorCode:
          type: string
        details:
          $ref: e288252a-1a5c-4f61-a45d-43bb0ec01ab5
          description: Parameter validation issues, when available.
      required:
        - error
        - errorCode
      additionalProperties: false
      $defs:
        __schema0:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: 'null'
            - type: array
              items:
                $ref: '#/components/schemas/Error/$defs/__schema0'
            - type: object
              propertyNames:
                type: string
              additionalProperties:
                $ref: '#/components/schemas/Error/$defs/__schema0'
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: A brand-scoped or global amb_sk_... API key.

````