Greenhouse Countries API

openapi: 3.2.0
info:
  title: Greenhouse Countries API
  version: v1
  description: 'Operations tagged Countries 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: Countries
paths:
  /v1/countries:
    get:
      summary: List countries
      description: Returns all countries and their subdivisions. Countries are sorted alphabetically by name. The optional `country_codes[]` filter accepts ISO 3166-1 alpha-3 codes (e.g., USA, CAN). Countries without subdivisions return an empty `states` array. All results are returned in a single response; this endpoint is not paginated.
      tags:
      - Countries
      security:
      - oauth2:
        - v1:countries:list
      - bearer: []
      parameters:
      - name: country_codes
        in: query
        required: false
        description: Filter by ISO 3166-1 alpha-3 country codes (e.g., USA, CAN)
        style: form
        explode: false
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful
          content:
            application/json:
              examples:
                example_response:
                  value:
                  - name: Canada
                    country_code: CAN
                    states:
                    - name: Alberta
                      code: AB
                    - name: Ontario
                      code: 'ON'
                  - name: Maldives
                    country_code: MDV
                    states: []
                  - name: United States of America
                    country_code: USA
                    states:
                    - name: California
                      code: CA
                    - name: New York
                      code: NY
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: false
                  properties:
                    name:
                      type: string
                    country_code:
                      type: string
                    states:
                      type: array
                      items:
                        type: object
                        additionalProperties: false
                        properties:
                          name:
                            type: string
                          code:
                            type: string
      operationId: getV1Countries
      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