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

# List vendors

> Return the vendors tracked in your organization, one page at a time.



## OpenAPI

````yaml api-reference/openapi.json GET /vendors
openapi: 3.0.0
info:
  title: DSALTA API
  version: 1.0.0
  description: >-
    DSALTA Public API (v1). Authenticate with a Bearer API token issued from
    your organization settings. Each token carries resource-level scopes (e.g.
    documents:read).
  contact: {}
servers:
  - url: https://apip.dsalta.com/v1
    description: Production
security: []
paths:
  /vendors:
    get:
      tags:
        - Vendors
      summary: List Vendors
      operationId: ListVendors
      parameters:
        - in: query
          name: page
          required: false
          schema:
            type: number
            format: double
        - in: query
          name: limit
          required: false
          schema:
            type: number
            format: double
        - in: query
          name: search
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicListResponse_PublicVendor_'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Example 1:
                  value:
                    success: false
                    message: Invalid or expired API token
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Example 1:
                  value:
                    success: false
                    message: 'API token is missing required scope(s): vendors:read'
      security:
        - apiToken:
            - vendors:read
components:
  schemas:
    PublicListResponse_PublicVendor_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PublicVendor'
          type: array
        pagination:
          $ref: '#/components/schemas/PublicPaginationMeta'
      required:
        - data
        - pagination
      type: object
      additionalProperties: false
    ErrorResponse:
      properties:
        details:
          $ref: '#/components/schemas/Record_string.unknown_'
        message:
          type: string
        success:
          type: boolean
          enum:
            - false
          nullable: false
      required:
        - message
        - success
      type: object
    PublicVendor:
      description: >-
        Public (v1) shape for a vendor. A curated subset of the internal vendor
        model.


        Excluded on purpose (sensitive or internal): the vendor's primary
        contact

        (third-party PII), IP addresses (infrastructure detail), the per-factor

        security-score breakdown, internal notes, discovery source, estimation
        time

        and vendor history. The overall grade and score ARE exposed — they are
        the

        organisation's own assessment of its own vendor.
      properties:
        id:
          type: string
        name:
          type: string
        domain:
          type: string
        category:
          type: string
          nullable: true
        industry:
          type: string
        tier:
          type: string
          description: Risk tier assigned to the vendor.
        grade:
          type: string
          description: Overall security grade, e.g. "A" | "B" | "C".
        score:
          type: number
          format: double
          description: Overall security score (0–100).
        monitoring:
          type: string
          description: Monitoring state.
        status:
          type: string
          description: '"Active" | "Inactive".'
        lastAssessmentDate:
          type: string
          nullable: true
          description: ISO 8601 of the last assessment, or null.
        contractExpiresAt:
          type: string
          nullable: true
          description: ISO 8601 contract expiry, or null.
        reviewDate:
          type: string
          nullable: true
          description: ISO 8601 next review date, or null.
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
        - id
        - name
        - domain
        - category
        - industry
        - tier
        - grade
        - score
        - monitoring
        - status
        - lastAssessmentDate
        - contractExpiresAt
        - reviewDate
        - createdAt
        - updatedAt
      type: object
      additionalProperties: false
    PublicPaginationMeta:
      description: >-
        Public API (v1) response envelope.


        The internal controllers are inconsistent — some return
        `SuccessResponse<T>`,

        some a bare `{ data, total }`. The public contract standardises on one
        shape

        so customers integrate against something stable:
          - single item  -> { data: T }
          - collection    -> { data: T[], pagination: {...} }

        These types are part of the published contract. Changing a field here is
        a

        breaking API change, not an internal refactor.
      properties:
        page:
          type: number
          format: double
          description: 1-based page number echoed back from the request.
        limit:
          type: number
          format: double
          description: Page size echoed back from the request.
        total:
          type: number
          format: double
          description: Total number of records across all pages.
        totalPages:
          type: number
          format: double
          description: Total number of pages at this page size.
      required:
        - page
        - limit
        - total
        - totalPages
      type: object
      additionalProperties: false
    Record_string.unknown_:
      properties: {}
      type: object
      description: Construct a type with a set of properties K of type T
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: DSALTA_API_TOKEN

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.