Greenhouse Documents API

The Documents API from Greenhouse — 1 operation(s) for documents.

Operations 1

GET /v1/documents List documents #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/greenhouse:greenhouse-documents-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

greenhouse-documents-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Greenhouse Documents API
  version: v1
  description: 'Operations tagged Documents across 2 of this provider''s published API definitions: greenhouse-onboarding-v1-openapi.json, greenhouse-onboarding-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://onboarding-api.greenhouse.io
security:
- bearer: []
tags:
- name: Documents
paths:
  /v1/documents:
    get:
      summary: List documents
      tags:
      - Documents
      security:
      - oauth2:
        - v1:documents:list
      - bearer: []
      parameters:
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: Cursor link for pagination from previous page response header. Do not use any other parameters when using this.
      - name: per_page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 500
          default: 100
        description: Number of results per page
      - name: ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: created_at
        in: query
        required: false
        schema:
          type: object
          properties:
            gte:
              type: string
              format: date-time
            lte:
              type: string
              format: date-time
            gt:
              type: string
              format: date-time
            lt:
              type: string
              format: date-time
            any_value:
              type: boolean
            no_value:
              type: boolean
        style: pipeDelimited
      - name: updated_at
        in: query
        required: false
        schema:
          type: object
          properties:
            gte:
              type: string
              format: date-time
            lte:
              type: string
              format: date-time
            gt:
              type: string
              format: date-time
            lt:
              type: string
              format: date-time
            any_value:
              type: boolean
            no_value:
              type: boolean
        style: pipeDelimited
      - name: employee_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: team_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: pending_hire_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: signature_request_template_ids
        in: query
        required: false
        description: Comma separated list
        style: form
        explode: false
        schema:
          type: array
          items:
            type: integer
          maxItems: 50
      - name: fields
        in: query
        required: false
        description: Comma separated list of fields to return
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            pattern: (?i-mx:^(?i-mx:[a-z]+(?:_[a-z]+)*)+(?:,(?i-mx:[a-z]+(?:_[a-z]+)*)+)*$)
          maxItems: 50
      - name: owner_type
        in: query
        required: false
        description: Filter by owner type. Comma-separated list.
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
            enum:
            - Employee
            - Team
            - PendingHire
            - SignatureRequestTemplate
            - Company
          maxItems: 50
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                example_response:
                  value:
                  - id: 1
                    owner_id: 1
                    owner_type: Employee
                    created_at: '2024-01-01T12:30:30.000Z'
                    updated_at: '2024-01-01T12:30:30.000Z'
                    name: null
                    description: My file description is pretty bomb yo.
                    file_content_type: text/plain
                    has_signature: false
                    template: false
                    virus_status: to_be_scanned
                    virus_scan_date: null
                    file_name: example.txt
                    file_size: 16
                    source: unknown
                    download_url: /system/test/files/original/9aaee736b9ed3013494459f3b5492b735f9b5b17.txt?1
              schema:
                type: array
                uniqueItems: true
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    id:
                      type: integer
                    created_at:
                      type: string
                      format: date-time
                    updated_at:
                      type: string
                      format: date-time
                    owner_id:
                      type:
                      - integer
                      - 'null'
                    owner_type:
                      type:
                      - string
                      - 'null'
                    name:
                      type:
                      - string
                      - 'null'
                    description:
                      type:
                      - string
                      - 'null'
                    file_name:
                      type:
                      - string
                      - 'null'
                    file_size:
                      type:
                      - integer
                      - 'null'
                    file_content_type:
                      type:
                      - string
                      - 'null'
                    has_signature:
                      type:
                      - boolean
                      - 'null'
                    template:
                      type:
                      - boolean
                      - 'null'
                    source:
                      type:
                      - string
                      - 'null'
                    virus_status:
                      type:
                      - string
                      - 'null'
                    virus_scan_date:
                      type:
                      - string
                      - 'null'
                      format: date-time
                    download_url:
                      type:
                      - string
                      - 'null'
      operationId: getV1Documents
      x-operation-id-source: derived
    servers:
    - url: https://onboarding-api.greenhouse.io
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth2 Authentication
      flows:
        clientCredentials:
          tokenUrl: https://auth.greenhouse.io/token
          scopes:
            v1:bulk_requests:list: List current bulk requests.
            v1:countries:list: List all countries and their subdivisions.
            v1:custom_fields:list: List all of the custom fields.
            v1:documents:list: List all of the documents.
            v1:employees:list: List all of the employees.
            v1:employees:update: Update a single employee.
            v1:other_criteria:list: List all of the other criteria.
            v1:pending_hires:create: Create a single pending hire.
            v1:pending_hires:destroy: Delete a single pending hire.
            v1:pending_hires:list: List all of the pending hires.
            v1:pending_hires:update: Update a single pending hire.
            v1:signature_request_templates:list: List all of the signature request templates.
            v1:signature_requests:list: List all of the signature requests.
            v1:team_categories:list: List all of the team categories.
            v1:teams:create: Create a single team.
            v1:teams:destroy: Delete a single team.
            v1:teams:list: List all of the teams.
            v1:teams:update: Update a single team.
        authorizationCode:
          authorizationUrl: https://auth.greenhouse.io/authorize
          tokenUrl: https://auth.greenhouse.io/token
          refreshUrl: https://auth.greenhouse.io/token
          scopes:
            v1:bulk_requests:list: List current bulk requests.
            v1:countries:list: List all countries and their subdivisions.
            v1:custom_fields:list: List all of the custom fields.
            v1:documents:list: List all of the documents.
            v1:employees:list: List all of the employees.
            v1:employees:update: Update a single employee.
            v1:other_criteria:list: List all of the other criteria.
            v1:pending_hires:create: Create a single pending hire.
            v1:pending_hires:destroy: Delete a single pending hire.
            v1:pending_hires:list: List all of the pending hires.
            v1:pending_hires:update: Update a single pending hire.
            v1:signature_request_templates:list: List all of the signature request templates.
            v1:signature_requests:list: List all of the signature requests.
            v1:team_categories:list: List all of the team categories.
            v1:teams:create: Create a single team.
            v1:teams:destroy: Delete a single team.
            v1:teams:list: List all of the teams.
            v1:teams:update: Update a single team.
x-refined-from:
- greenhouse-onboarding-v1-openapi.json
- greenhouse-onboarding-v1-openapi.yml
x-readme:
  headers: []
x-readme-fauxas: true