Work Market · Schema

Template

Workforce ManagementContractorsFreelanceGig EconomyHuman ResourcesPaymentsField ServicesStaffing

Properties

Name Type Description
template_id string template_id
title string
description string
instructions string
desired_skills string
project integer
client integer
internal_owner string
internal_owner_details object
sent_worker_count integer
assignment_window_start integer
assignment_window_start_date string
assignment_window_end integer
assignment_window_end_date string
scheduled_time integer
scheduled_time_date string
scheduled_start integer
scheduled_end integer
reschedule_request object
budget_increase_request object
expense_reimbursement_request object
bonus_request object
industry string
time_zone string
required_attachments integer
location object
location_offsite boolean
location_contact object
support_contact object
pricing object
invoice_number string
attachments array
created_on integer
last_modified_on integer
notes array
custom_fields array
parts_group object
pending_offers array
declined_resources array
questions array
deliverables_fulfilled boolean
template_name string
template_description string
View JSON Schema on GitHub

JSON Schema

work-market-template.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Template",
  "x-generated": "2026-07-21",
  "x-method": "derived",
  "x-source": "openapi/work-market-employer-api-openapi.yml#",
  "type": "object",
  "properties": {
    "template_id": {
      "type": "string",
      "description": "template_id",
      "readOnly": true
    },
    "title": {
      "type": "string",
      "readOnly": true
    },
    "description": {
      "type": "string",
      "readOnly": true
    },
    "instructions": {
      "type": "string",
      "readOnly": true
    },
    "desired_skills": {
      "type": "string",
      "readOnly": true
    },
    "project": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "client": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "internal_owner": {
      "type": "string",
      "readOnly": true
    },
    "internal_owner_details": {
      "readOnly": true,
      "$ref": "#/definitions/InternalOwnerDetails"
    },
    "sent_worker_count": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "assignment_window_start": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "assignment_window_start_date": {
      "type": "string",
      "readOnly": true
    },
    "assignment_window_end": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "assignment_window_end_date": {
      "type": "string",
      "readOnly": true
    },
    "scheduled_time": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "scheduled_time_date": {
      "type": "string",
      "readOnly": true
    },
    "scheduled_start": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "scheduled_end": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "reschedule_request": {
      "readOnly": true,
      "$ref": "#/definitions/RescheduleRequest"
    },
    "budget_increase_request": {
      "readOnly": true,
      "$ref": "#/definitions/BudgetIncreaseRequest"
    },
    "expense_reimbursement_request": {
      "readOnly": true,
      "$ref": "#/definitions/ExpenseReimbursementRequest"
    },
    "bonus_request": {
      "readOnly": true,
      "$ref": "#/definitions/BonusRequest"
    },
    "industry": {
      "type": "string",
      "readOnly": true
    },
    "time_zone": {
      "type": "string",
      "readOnly": true
    },
    "required_attachments": {
      "type": "integer",
      "format": "int32",
      "readOnly": true
    },
    "location": {
      "readOnly": true,
      "$ref": "#/definitions/Location"
    },
    "location_offsite": {
      "type": "boolean",
      "readOnly": true
    },
    "location_contact": {
      "readOnly": true,
      "$ref": "#/definitions/LocationContact"
    },
    "support_contact": {
      "readOnly": true,
      "$ref": "#/definitions/SupportContact"
    },
    "pricing": {
      "readOnly": true,
      "$ref": "#/definitions/Pricing"
    },
    "invoice_number": {
      "type": "string",
      "readOnly": true
    },
    "attachments": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/definitions/AssignmentDetailsAttachment"
      }
    },
    "created_on": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "last_modified_on": {
      "type": "integer",
      "format": "int64",
      "readOnly": true
    },
    "notes": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/definitions/Note"
      }
    },
    "custom_fields": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/definitions/CustomFieldGroup"
      }
    },
    "parts_group": {
      "readOnly": true,
      "$ref": "#/definitions/PartsGroup"
    },
    "pending_offers": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/definitions/Application"
      }
    },
    "declined_resources": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/definitions/DeclinedResource"
      }
    },
    "questions": {
      "type": "array",
      "readOnly": true,
      "items": {
        "$ref": "#/definitions/QuestionAnswerPair"
      }
    },
    "deliverables_fulfilled": {
      "type": "boolean",
      "readOnly": true
    },
    "template_name": {
      "type": "string",
      "readOnly": true
    },
    "template_description": {
      "type": "string",
      "readOnly": true
    }
  },
  "definitions": {
    "ApplicantProfile": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true
        },
        "first_name": {
          "type": "string",
          "readOnly": true
        },
        "last_name": {
          "type": "string",
          "readOnly": true
        },
        "email": {
          "type": "string",
          "readOnly": true
        },
        "company_name": {
          "type": "string",
          "readOnly": true
        },
        "rating": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "number_of_ratings": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        },
        "job_title": {
          "type": "string",
          "readOnly": true
        },
        "overview": {
          "type": "string",
          "readOnly": true
        },
        "phone_numbers": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/PhoneNumber"
          }
        },
        "uuid": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Application": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "note": {
          "type": "string",
          "readOnly": true
        },
        "resource": {
          "readOnly": true,
          "$ref": "#/definitions/ApplicantProfile"
        },
        "scheduling": {
          "readOnly": true,
          "$ref": "#/definitions/RescheduleRequest"
        },
        "pricing": {
          "readOnly": true,
          "$ref": "#/definitions/Pricing"
        },
        "expires_on": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "expired": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "AssignmentDetailsAttachment": {
      "type": "object",
      "properties": {
        "uuid": {
          "type": "string",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "readOnly": true
        },
        "description": {
          "type": "string",
          "readOnly": true
        },
        "relative_uri": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "BonusRequest": {
      "type": "object",
      "properties": {
        "bonus": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "note": {
          "type": "string",
          "readOnly": true
        },
        "requested_on": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "BudgetIncreaseRequest": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "readOnly": true
        },
        "spend_limit": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "budget_increases": {
          "type": "string",
          "readOnly": true
        },
        "expense_reimbursements": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "bonuses": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "additional_expenses": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "flat_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "per_hour_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "max_number_of_hours": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "per_unit_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "max_number_of_units": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "initial_per_hour_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "initial_number_of_hours": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "additional_per_hour_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "max_blended_number_of_hours": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "note": {
          "type": "string",
          "readOnly": true
        },
        "requested_on": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "CustomField": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "readOnly": true
        },
        "default": {
          "type": "string",
          "readOnly": true
        },
        "required": {
          "type": "boolean",
          "readOnly": true
        },
        "value": {
          "type": "string",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "CustomFieldGroup": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "readOnly": true
        },
        "fields": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/CustomField"
          }
        },
        "required": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "DeclinedResource": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true
        },
        "first_name": {
          "type": "string",
          "readOnly": true
        },
        "last_name": {
          "type": "string",
          "readOnly": true
        },
        "email": {
          "type": "string",
          "readOnly": true
        },
        "phone_numbers": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/PhoneNumber"
          }
        },
        "uuid": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ExpenseReimbursementRequest": {
      "type": "object",
      "properties": {
        "expense_reimbursement": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "note": {
          "type": "string",
          "readOnly": true
        },
        "requested_on": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        }
      }
    },
    "InternalOwnerDetails": {
      "type": "object",
      "properties": {
        "first_name": {
          "type": "string",
          "readOnly": true
        },
        "last_name": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Location": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "readOnly": true
        },
        "location_number": {
          "type": "string",
          "readOnly": true
        },
        "instructions": {
          "type": "string",
          "readOnly": true
        },
        "address_1": {
          "type": "string",
          "readOnly": true
        },
        "address_2": {
          "type": "string",
          "readOnly": true
        },
        "city": {
          "type": "string",
          "readOnly": true
        },
        "state": {
          "type": "string",
          "readOnly": true
        },
        "zip": {
          "type": "string",
          "readOnly": true
        },
        "country": {
          "type": "string",
          "readOnly": true
        },
        "latitude": {
          "type": "string",
          "readOnly": true
        },
        "longitude": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "LocationContact": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "first_name": {
          "type": "string",
          "readOnly": true
        },
        "last_name": {
          "type": "string",
          "readOnly": true
        },
        "email": {
          "type": "string",
          "readOnly": true
        },
        "phone_numbers": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/PhoneNumber"
          }
        }
      }
    },
    "Note": {
      "type": "object",
      "properties": {
        "date": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "text": {
          "type": "string",
          "readOnly": true
        },
        "created_by": {
          "type": "string",
          "readOnly": true
        },
        "is_private": {
          "type": "boolean",
          "readOnly": true
        },
        "is_privileged": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "PartLocation": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "readOnly": true
        },
        "address1": {
          "type": "string",
          "readOnly": true
        },
        "address2": {
          "type": "string",
          "readOnly": true
        },
        "city": {
          "type": "string",
          "readOnly": true
        },
        "state": {
          "type": "string",
          "readOnly": true
        },
        "zip": {
          "type": "string",
          "readOnly": true
        },
        "country": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Parts": {
      "type": "object",
      "properties": {
        "part_value": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "part_name": {
          "type": "string",
          "readOnly": true
        },
        "part_number": {
          "type": "string",
          "readOnly": true
        },
        "shipping_provider": {
          "type": "string",
          "readOnly": true
        },
        "tracking_number": {
          "type": "string",
          "readOnly": true
        },
        "priority": {
          "type": "string",
          "readOnly": true
        },
        "deliver_to": {
          "type": "string",
          "readOnly": true
        },
        "part_count": {
          "type": "integer",
          "format": "int32",
          "readOnly": true
        }
      }
    },
    "PartsGroup": {
      "type": "object",
      "properties": {
        "supplied_by_resource": {
          "type": "boolean",
          "readOnly": true
        },
        "return_required": {
          "type": "boolean",
          "readOnly": true
        },
        "distribution_method": {
          "type": "string",
          "readOnly": true
        },
        "pickup_location": {
          "readOnly": true,
          "$ref": "#/definitions/PartLocation"
        },
        "site_parts": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/Parts"
          }
        },
        "return_parts": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/Parts"
          }
        }
      }
    },
    "PhoneNumber": {
      "type": "object",
      "properties": {
        "country_code": {
          "type": "string",
          "readOnly": true
        },
        "phone": {
          "type": "string",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "readOnly": true,
          "enum": [
            "WORK",
            "HOME",
            "OTHER",
            "MOBILE"
          ]
        },
        "extension": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "Pricing": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "readOnly": true
        },
        "spend_limit": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "budget_increases": {
          "type": "string",
          "readOnly": true
        },
        "expense_reimbursements": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "bonuses": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "additional_expenses": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "flat_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "per_hour_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "max_number_of_hours": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "per_unit_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "max_number_of_units": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "initial_per_hour_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "initial_number_of_hours": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "additional_per_hour_price": {
          "type": "number",
          "format": "double",
          "readOnly": true
        },
        "max_blended_number_of_hours": {
          "type": "number",
          "format": "double",
          "readOnly": true
        }
      }
    },
    "QuestionAnswerPair": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "question": {
          "type": "string",
          "readOnly": true
        },
        "answer": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "RescheduleRequest": {
      "type": "object",
      "properties": {
        "note": {
          "type": "string",
          "readOnly": true
        },
        "requested_on": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "request_window_start": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "request_window_end": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "request_scheduled_time": {
          "type": "integer",
          "format": "int64",
          "readOnly": true
        },
        "requested_by_resource": {
          "type": "boolean",
          "readOnly": true
        }
      }
    },
    "SupportContact": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true
        },
        "first_name": {
          "type": "string",
          "readOnly": true
        },
        "last_name": {
          "type": "string",
          "readOnly": true
        },
        "email": {
          "type": "string",
          "readOnly": true
        },
        "phone_numbers": {
          "type": "array",
          "readOnly": true,
          "items": {
            "$ref": "#/definitions/PhoneNumber"
          }
        }
      }
    }
  }
}