v3

latestSwagger 2.02026-08-067506752.0 MB

job

Find jobs in the organization

get/v2/org/{orgId}/job

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

scenarioIdstring

Scenario id to query

compReviewIdstring

Comp review id to query

approvalChainIdstring

Approval chain id to query; only relevant when there is a comp review id

datestring date

Date to search as of

startDatestring date

Start date, if retrieving jobs that existed between two dates (inclusive)

endDatestring date

End date, if retrieving jobs that existed between two dates (inclusive)

qstring

Search query

idsstring

Comma-separated list of job ids to look up

fromstring

Job id to start paginating from

limitinteger

Number of results to return

sortstring

Sort by fields, comma-separated. For descending sort, prepend a -

fieldsstring

Fields to retrieve, comma-separated

fieldsListstring[]

Fields to retrieve, list syntax

formatstring

Data format to use; default is json, can also use json-extended or json-readable

splitColumnsboolean

Whether to split complex columns, used for tabular data formats

useScenarioChangesboolean

Find jobs only based on the changes that are in the scenario. This option also allows you to reference the change within the filter, which is otherwise not allowed

returnAccessstring

Return access information -- pass a list of actions to check, for example: create,update,delete

Response

successful operation

dataobject[] required

nextstring

totalRowobject

Example response

{
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}