Sign in

v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
estimates

Get Estimates

Use this endpoint to get all estimates for the current location. Supported includes: job.

get/estimates

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
pageStartIndexinteger

Specifies the starting position for paginated results.

  • Default: 0 (first page) if not specified
  • Minimum: 0
  • Example: pageStartIndex=25 with pageSize=25 returns the second page of results
includesstring

Optional fields to include in full with the response.

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": [
    {
      "id": "01a7cfc1-2231-4589-9657-7f3004c06bd3",
      "job": {
        "id": "e591bf22-9828-4144-bca8-42cbb8c6e2c0",
        "_link": "https://api.acculynx.com/api/v2/jobs/e591bf22-9828-4144-bca8-42cbb8c6e2c0"
      },
      "_link": "https://api.acculynx.com/api/v2/estimates/01a7cfc1-2231-4589-9657-7f3004c06bd3"
    }
  ]
}