Identifiers & references

Identifiers & references

The SEEK API provides a number of fields that can be used to identify a position. They fall into two separate categories:
  1. The PositionOpening.documentId and PositionProfile.profileId fields are unique object identifiers assigned by the SEEK API.
    While these are the primary way to identify positions in the SEEK API, they’re not available in our legacy integrations or the SEEK employer website .
  2. Reference fields are optional strings that can be provided when creating a position opening or posting a job ad. The SEEK API does not require that references are unique.
    Depending on the particular reference field, they can be used to correlate positions with our legacy integrations or the SEEK employer website.

Reference fields

seekHirerJobReference

The PositionProfile.seekHirerJobReference field is a generic reference that can be populated and viewed in all channels. This makes it useful for supporting cross-channel workflows such as exporting applications for jobs posted outside the SEEK API. SEEK hirers typically use this as their primary reference due to its broad support.

seekBillingReference

The PositionProfile.seekBillingReference field is intended to contain a billing reference or cost centre code. While not as widely supported as the seekHirerJobReference, it consistently appears on hirer invoices & contract reporting.

seekPartnerMetadata

The PositionOpening.seekPartnerMetadata & PositionProfile.seekPartnerMetadata fields are intended to contain opaque metadata that’s useful to your software. They can only be populated or retrieved via the SEEK API; they’re not directly exposed to SEEK hirers.
Note that SEEK hirers can have relationships with multiple integration partners or move between integration partners over time. Your software should gracefully handle fields that contain unexpected data populated by other integration partners.

Channel support

Populated by

The table below shows which identifiers & references can be populated in each channel.
Field
SEEK API
SEEK employer website
PositionOpening.documentId
PositionOpening.seekPartnerMetadata
PositionProfile.profileId
PositionProfile.seekHirerJobReference
as `jobReference`
PositionProfile.seekBillingReference
as `agentJobReference`
PositionProfile.seekPartnerMetadata
  Referred to as “agent job reference”. Only available when posting as an agency on behalf of a hirer.

Visible in

The table below shows which identifiers & references can be viewed in each channel.
Field
SEEK API
SEEK employer website
Hirer billing & reports
PositionOpening.documentId
PositionOpening.seekPartnerMetadata
PositionProfile.profileId
PositionProfile.seekHirerJobReference
as `JobReference`
PositionProfile.seekBillingReference
PositionProfile.seekPartnerMetadata
  Referred to as “agent job reference”. Only available when posting as an agency on behalf of a hirer.