Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
jobs

Get Job Change History

Use this endpoint to get a history of actions performed for a job. Supported includes: createdBy. When startDate and endDate are specified, actions returned will be filtered to those created between those dates (inclusive). This endpoint will return a paginated response starting from the given record index.

get/jobs/{jobId}/history

Path parameters

jobIdstring uuid required

The job's unique identifier

Query parameters

pageSizeinteger

Controls how many items are returned per page in paginated responses.

  • Default: 25 items per page if not specified
  • Minimum: 1 item per page
  • Use with pageStartIndex for navigating through large result sets
recordStartIndexinteger

The index of the first element to return

includesstring

Optional fields to include in full with the response.

startDatestring date

Start date for the query, in YYYY-MM-DD format.

endDatestring date

End date for the query, in YYYY-MM-DD format.

Response

OK

countinteger

The total number of items available across all pages. Use this to calculate the total number of pages available.

pageSizeinteger

The number of items per page in this response. This reflects either your requested page size or the default value.

pageStartIndexinteger

The starting index of this page of results. Use with pageSize to track your position in the overall result set.

Example response

{
  "items": [
    {
      "action": "Company Representative changed from Jimmy to Julie",
      "type": "Job",
      "date": "2020-06-22T05:00:00Z",
      "createdBy": {
        "id": "228db892-3b49-4455-b839-ffd8576d8731",
        "_link": "https://api.acculynx.com/api/v2/users/228db892-3b49-4455-b839-ffd8576d8731"
      }
    }
  ]
}