v1

latestOpenAPI 3.0.0Proprietary2026-07-26130282259.8 KB
contacts

Get Jobs for a Contact

Retrieves a paginated list of all jobs that the contact is associated with.

Pagination:

  • PageStartIndex: Zero-based index of the first record to return (default: 0)
  • PageSize: Number of records per page (default: 25, max: 50)
  • Both pagination parameters are optional

Behavior:

  • Returns 200 with an empty items array if the contact exists but has no jobs associated
  • Returns 400 if any path or a query string parameter (contactId, pageSize, pageStartIndex) doesn't fulfill the validations
  • Returns 404 if the contactId does not exist
  • Returns 416 if pageStartIndex or pageSize are negative, or exceeds the maximum allowed
  • Returns 500 if an internal error occurs.
get/contacts/{contactId}/jobs

Path parameters

contactIdstring uuid required

The contact'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

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": "2656d230-82bb-4c41-ae04-aa38426eebad",
      "_link": "https://api.acculynx.com/v2/jobs/2656d230-82bb-4c41-ae04-aa38426eebad"
    },
    {
      "id": "94935bc9-63e5-4b9c-af17-430661a699f9",
      "_link": "https://api.acculynx.com/v2/jobs/94935bc9-63e5-4b9c-af17-430661a699f9"
    }
  ]
}