openapi: 3.0.3
info:
  title: Puzzle Api Accounts Departments API
  description: Puzzle Api
  version: '0'
servers:
- url: https://staging.southparkdata.com/rest/v0
tags:
- name: Departments
paths:
  /company/{id}/departments:
    get:
      operationId: departments
      summary: Get Departments
      description: 'Retrieves a list of all departments for the given company.


        Requires scope: read:company'
      tags:
      - Departments
      parameters:
      - name: id
        in: path
        required: true
        description: The company ID
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  departments:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                          description: Partner-facing external identifier
                        name:
                          type: string
                      required:
                      - id
                      - name
                required:
                - departments
    post:
      operationId: createDepartment
      summary: Create Department
      description: 'Create a department for the given company.


        Departments must have a unique name. A 400 error will be thrown if a department with the same name already exists.


        Requires scope: write:department'
      tags:
      - Departments
      parameters:
      - name: id
        in: path
        required: true
        description: The company ID
        schema:
          type: string
          minLength: 1
          description: Partner-facing external identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
              required:
              - name
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                    description: Partner-facing external identifier
                  name:
                    type: string
                required:
                - id
                - name