BIbigchange
Jobs

Get a list of job worksheets

Retrieve a paged collection of worksheets for a given job (required scope jobs:read)

get/v1/jobs/{jobId}/worksheets

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobs/{jobId}/worksheets
  • Auth
    HTTP bearer

Path parameters

jobIdinteger required

The unique identifer of the job

Query parameters

includeBranchedWorksheetsboolean

Whether to include branched worksheets in the response

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "id": 1234,
      "name": "Worksheet Example Name",
      "linkType": "linkedToJob"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}

Changes

No recorded changes to this operation across all 13 revisions of this API.