Initialize a draft for review and completion in Shor

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "employmentType": "employee",
  "contractType": "employment_at_will",
  "status": "draft",
  "worker": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

POST

contracts

Error

A valid request URL is required to generate request examples

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "employmentType": "employee",
  "contractType": "employment_at_will",
  "status": "draft",
  "worker": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "startDate": "2023-12-25",
  "endDate": "2023-12-25",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "<string>",
    "message": "<string>",
    "status": 0,
    "requestId": "<string>",
    "details": [
      {
        "path": "<string>",
        "code": "<string>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key

string

required

Unique intent ID. Preserve across retries; use a new value for an intentional new operation.

Required string length: 16 - 128

Pattern: ^[A-Za-z0-9_-]+$

Body

application/json

title

string

required

Required string length: 1 - 200

professionalEmail

string<email>

Maximum string length: 254

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

description

string

Maximum string length: 10000

employmentType

enum<string>

Available options:

employee,

contractor

contractType

enum<string>

Available options:

employment_at_will,

contractor_fixed,

contractor_milestone,

contractor_payg

countryOfEmployment

string

Required string length: 2

startDate

string<date>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

endDate

string<date>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

noticePeriodDays

integer

Required range: 0 <= x <= 9007199254740991

department

enum<string>

Available options:

business_development,

customer_support,

data,

design,

engineering,

finance,

hr,

it,

legal,

marketing,

operations,

product,

sales,

other

seniority

enum<string>

Available options:

intern,

lv1,

lv2,

lv3,

lv4,

lv5,

lead,

manager,

director,

vp,

c_level

employmentSubtype

enum<string>

Available options:

full_time,

part_time

terminationDate

string<date>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

specialClauses

string

Maximum string length: 20000

serviceTypes

string[]

skills

string[]

tools

string[]

disputeResolutionMethod

enum<string>

Available options:

arbitration,

court

governingCountry

string

Required string length: 2

governingStateProvince

string

Maximum string length: 100

compensation

object

Show child attributes

invoicingSettings

object

Show child attributes

benefits

object

Show child attributes

milestones

object[]

Show child attributes

workSchedule

string

externalReference

string

Required string length: 1 - 128

Response

Success

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

title

string

required

employmentType

enum<string>

required

Available options:

employee,

contractor

contractType

enum<string>

required

Available options:

employment_at_will,

contractor_fixed,

contractor_milestone,

contractor_payg

status

enum<string>

required

Available options:

draft,

pending_verification,

ready_for_signature,

pending_signature,

signed,

active,

offboarding,

completed,

cancelled

worker

object

required

Show child attributes

startDate

string<date> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

endDate

string<date> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

updatedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

deletedAt

string<date-time> | null

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$