Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Get Job External References

Use this endpoint to get a external reference based on the following query parameters:

  • jobId
  • projectId * case insensitive
  • source * mandatory & case insensitive
  • jobId and projectId are optional, but at least one of them are needed in the request.
get/jobs/external-references

Query parameters

jobIdstring uuid required

The job's unique identifier

projectIdstring
Example:123453ID

The unique identifier of the project associated with the external reference.

sourcestring required
Example:My first integration

The name of the source associated with the external reference.

Response

OK

jobIdstring uuid

The unique ID for the job.

companyIdstring uuid

The unique ID for the company.

sourcestring

The source of the external reference

projectIdstring

The projectId of the external reference.

Example response

[
  {
    "jobId": "980783c8-7a34-4b20-a644-d6d94eff3b96",
    "companyId": "980783c8-7a34-4b20-a644-d6d94eff3b96",
    "source": "The external reference source",
    "projectId": "This is the projectId"
  }
]