GET /jobs/{job_gid}

Required scope: jobs:read

FieldRequired Scope
new_task_templatetask_templates:read
new_portfolioportfolios:read
new_projectprojects:read
new_tasktasks:read
new_project_templateproject_templates:read

Returns the full record for a job.

Servers

Path parameters

Name Type Required Description
job_gid String Yes

Globally unique identifier for the job.

Query parameters

Name Type Required Description
opt_pretty Boolean No

Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

opt_fields[] Array No

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.