Skip to main content

[en] Jobs Endpoints

[en] Jobs Endpoints and Parameters

[en] Get Information about a Specific Job

[en] To learn more about the objects relations and how to use them in the API, go to the Object Relations section.

[en] For more information about jobs, visit the Jobs: Admin Interface help page.

[en] Get Information about a Specific Job

[en] To get information about a specific job, use the GET {baseURL}/v3/jobs/{jobId} endpoint. Use various parameters to filter the jobs you want to display.

[en] Parameters

  • [en] jobId (string): Required. Enter the Job ID for which you want to display details.

  • [en] includeMessages (boolean): Optional. Can be left without a value. You can choose from the following values: ‘true’ and ‘false’. If this parameter is set to ‘false’, then a reduced object will be returned. When not specified, the ‘true’ value is used.

[en] Request Example: cURL

[en] curl -X GET --header 'Accept: application/json' --header 'Authorization: Bearer 'BearerTokenGoesHere' 'http://localhost/webapi/v3/jobs/635a4be7d27400005f001fec'

[en] Objects Relations

[en] If you want to get information about a specific job, you need a jobId. To obtain this jobId, use the GET {baseURL}/v3/workflows/{workflowId}/jobs endpoint. For more information about this endpoint, see the Workflows Endpoints help page.Workflow Endpoints

[en] Postman Requests

[en] To know more about Postman requests, visit the How to Use Postman help page.