JOjobadder
Placement API:Placements

Get a placement

Changed on
get/placements/{placementId}

Request

  • Base URL
    https://api.jobadder.com/v2
  • URL
    https://api.jobadder.com/v2/placements/{placementId}
  • Auth
    OAuth 2
    Authorization code: https://id.jobadder.com/connect/authorize
    Token URL: https://id.jobadder.com/connect/token scopes: read, read_placement

Path parameters

placementIdinteger required

Placement Id

Query parameters

Embedstring[]

Embed related resources.<br /> Resources available to embed are: notes

Response

Requested placement details

placementIdinteger required
jobTitlestring nullable
approvedboolean
approvedAtstring date-time nullable
type'Permanent' | 'Contract' | 'Temporary' | 'Credit' string required
startDatestring date nullable

Date employment begins

endDatestring date nullable

Date a contract or temporary employment ends

summarystring nullable
paymentTypestring nullable
awardstring nullable
industryCodestring nullable
chargeCurrencystring nullable
payCurrencystring nullable
feeSplit'Fixed' | 'Percent' string
createdAtstring date-time nullable
updatedAtstring date-time nullable

Example response

{
  "custom": [
    {
      "fieldId": 1,
      "name": "Text Field 1",
      "type": "Text",
      "value": "Text value"
    },
    {
      "fieldId": 2,
      "name": "List Field 2",
      "type": "List",
      "value": [
        "Value 1",
        "Value 2"
      ]
    },
    {
      "fieldId": 3,
      "name": "Date Field 3",
      "type": "Date",
      "value": "2018-07-01"
    }
  ]
}

Changes