action plaid_credit_employment_get {
  label: "Retrieve a summary of an individual's employment information"
  description: "`/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user."
  provider: plaid
  method: POST
  path: "/credit/employment/get"
  encoding: json
  input: {
    type: "object"
    description: "CreditEmploymentGetRequest defines the request schema for `/credit/employment/get`."
    required: ["user_token"]
    properties: {
      client_id: {
        type: "string"
        description: "Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body."
      }
      secret: {
        type: "string"
        description: "Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body."
      }
      user_token: {
        type: "string"
        description: "The user token associated with the User data is being requested for."
      }
    }
  }
  output: {
    type: "object"
    description: "CreditEmploymentGetResponse defines the response schema for `/credit/employment/get`."
    required: ["items", "request_id"]
    properties: {
      items: {
        type: "array"
        description: "Array of employment items."
        items: {
          type: "object"
          description: "The object containing employment items."
          required: ["item_id", "employments"]
          properties: {
            employment_report_token: {
              type: "string"
              description: "Token to represent the underlying Employment data"
            }
            employments: {
              type: "array"
              items: {
                type: "object"
                description: "The object containing proof of employment data for an individual."
                required: ["account_id", "status", "start_date", "end_date", "employer", "title", "platform_ids", "employee_type", "last_paystub_date"]
                properties: {
                  account_id: {
                    type: "string"
                    description: "ID of the payroll provider account."
                  }
                  employee_type: {
                    type: "string"
                    description: "The type of employment for the individual.\n`\"FULL_TIME\"`: A full-time employee.\n`\"PART_TIME\"`: A part-time employee.\n`\"CONTRACTOR\"`: An employee typically hired externally through a contracting group.\n`\"TEMPORARY\"`: A temporary employee.\n`\"OTHER\"`: The employee type is not one of the above defined types."
                  }
                  employer: {
                    type: "object"
                    description: "An object containing employer data."
                    required: ["name"]
                    properties: {
                      name: {
                        type: "string"
                        description: "Name of employer."
                      }
                    }
                  }
                  end_date: {
                    type: "string"
                    format: "date"
                    description: "End of employment, if applicable. Provided in ISO 8601 format (YYY-MM-DD)."
                  }
                  last_paystub_date: {
                    type: "string"
                    format: "date"
                    description: "The date of the employee's most recent paystub in ISO 8601 format (YYYY-MM-DD)."
                  }
                  platform_ids: {
                    type: "object"
                    description: "The object containing a set of ids related to an employee."
                    required: ["employee_id", "payroll_id", "position_id"]
                    properties: {
                      employee_id: {
                        type: "string"
                        description: "The ID of an employee as given by their employer."
                      }
                      payroll_id: {
                        type: "string"
                        description: "The ID of an employee as given by their payroll."
                      }
                      position_id: {
                        type: "string"
                        description: "The ID of the position of the employee."
                      }
                    }
                  }
                  start_date: {
                    type: "string"
                    format: "date"
                    description: "Start of employment in ISO 8601 format (YYYY-MM-DD)."
                  }
                  status: {
                    type: "string"
                    description: "Current employment status."
                  }
                  title: {
                    type: "string"
                    description: "Current title of employee."
                  }
                }
              }
            }
            item_id: {
              type: "string"
              description: "The `item_id` of the Item associated with this webhook, warning, or error"
            }
          }
        }
      }
      request_id: {
        type: "string"
        description: "A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive."
      }
    }
  }
}