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

# Get vendors



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/vendors
openapi: 3.0.0
info:
  title: Every Public API
  version: 1.0.0
  description: >
    The Every public API. Keys are issued per company and every response is
    scoped to the company

    that owns the calling key.


    Every response carries an `x-request-id` header, generated by Every for that
    request. Quote it

    when contacting support: it is the id the request is recorded under. A
    caller-supplied

    `x-request-id` is never echoed.
servers:
  - url: https://api.public.every.io/company
    description: Production
security:
  - apiKey: []
tags:
  - name: Company
    description: The company the calling key belongs to.
  - name: Vendors
    description: The people and businesses the company pays, and their W9 details.
  - name: Bank accounts
    description: A vendor's accounts at its own bank, the accounts payments are paid into.
  - name: Payments
    description: >-
      ACH payments from the company's Every account to a vendor, and where they
      are.
  - name: Reference data
    description: The categories and departments a payment is filed under.
paths:
  /v1/vendors:
    get:
      tags:
        - Vendors
      summary: Get vendors
      operationId: getVendors
      parameters:
        - name: limit
          in: query
          description: How many vendors to return, at most 1000
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 1000
        - name: offset
          in: query
          description: How many vendors to skip
          required: false
          schema:
            type: integer
            minimum: 0
      responses:
        '200':
          description: The vendors list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VendorsResponse'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/UnexpectedError'
components:
  schemas:
    VendorsResponse:
      type: object
      required:
        - data
        - metadata
      properties:
        data:
          description: List of vendors
          type: array
          items:
            $ref: '#/components/schemas/Vendor'
        metadata:
          $ref: '#/components/schemas/Metadata'
    Vendor:
      type: object
      required:
        - id
        - company_id
        - display_name
        - w9_complete
      properties:
        id:
          $ref: '#/components/schemas/Id'
        company_id:
          $ref: '#/components/schemas/Id'
        display_name:
          description: The vendor name, as shown in the Every dashboard
          type: string
        email:
          description: The vendor contact email
          type: string
          nullable: true
        created_at:
          description: The date the vendor was created
          type: string
          format: date
          nullable: true
        w9_complete:
          description: >-
            Whether the vendor's W9 details are on file. False while the vendor
            still has an onboarding form to fill in, whether it was asked
            through this API or in the Every dashboard.
          type: boolean
    Metadata:
      type: object
      required:
        - pagination
      properties:
        pagination:
          type: object
          required:
            - total
            - limit
            - offset
          properties:
            total:
              description: How many records exist, ignoring limit and offset
              type: integer
            limit:
              description: The limit the page was read with
              type: integer
            offset:
              description: The offset the page was read with
              type: integer
    Error:
      type: object
      properties:
        message:
          type: string
        errors:
          type: array
          items:
            type: object
    Id:
      type: string
      format: uuid
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The `x-api-key` header is missing, or the key is unknown, revoked, or
        not enabled for this API. The body is `{"message":"Forbidden"}`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    UnexpectedError:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````

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