Skip to main content
Notes & tags

List job notes

Returns non-private notes for a job. Tasks and private notes are excluded.

GET
/jobs/{jobId}/notes

Permissions

notes.read

Pagination

Use page and pageSize; see the query parameters below for defaults and limits. See Pagination & filtering for examples.

Authorizationstringheaderrequired

Use Authorization: Bearer <api-credential>.

jobIdnumberrequired

CVViZ job identifier.

Example: 901
pageintegerquerydefault:1

One-based page number.

Required range: 1 <= x
Example: 1
pageSizeintegerquerydefault:10

Number of records returned per page.

Required range: 1 <= x <= 100
Example: 10

Response

application/json

Successful response.

X-API-Daily-Limitintegerheader

Daily account request allowance, when metered. Shared across API credentials.

Required range: 0 <= x
X-API-Daily-Remainingintegerheader

Requests remaining in the daily window after admission.

Required range: 0 <= x
X-API-Daily-Resetstringheader

Daily window reset time in UTC.

X-API-Monthly-Limitintegerheader

Monthly account request allowance, when metered. Shared across API credentials.

Required range: 0 <= x
X-API-Monthly-Remainingintegerheader

Requests remaining in the monthly window after admission.

Required range: 0 <= x
X-API-Monthly-Resetstringheader

Monthly window reset time in UTC.

X-Request-IDstringheader

Request correlation identifier. Supply this value when contacting support.

Example: 01J7Y8N9P0Q1R2S3T4U5V6W7X8
X-API-Contractstringheader

Response envelope contract version.

Example: canonical-v1
RateLimit-Limitintegerheader

Account request limit for capacity add-ons; effective credential request-unit limit for included legacy access.

Example: 600
RateLimit-Remainingintegerheader

Requests remaining for capacity add-ons, or request units for included legacy access.

Example: 598
RateLimit-Resetintegerheader

Seconds until the current minute window resets.

Example: 30
dataobject[]required
metaobjectrequired