---
title: "Get Job Custom Fields"
method: GET
path: "/jobs/{jobId}/custom-fields"
tags: ["jobs"]
---

# Get Job Custom Fields

`GET /jobs/{jobId}/custom-fields`

## Request

- Base URL: `https://api.acculynx.com/api/v2`
- URL: `https://api.acculynx.com/api/v2/jobs/{jobId}/custom-fields`
- Auth: HTTP bearer

Get a list of all custom fields related to a specific job by its job Id.
This endpoint will return a paginated response starting from the given record index.
StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional.

## Path parameters

- `jobId` string, uuid, required

## Query parameters

- `pageSize` integer
- `recordStartIndex` integer

## Response `200`

A list of custom fields objects

- CustomFieldsCollection
  - `count` integer: The total number of items matching the current query.
  - `pageSize` integer: The requested or default page size.
  - `pageStartIndex` integer: The requested or default index of the first element to return.
  - `items` CustomField[]
    - `id` string, uuid
    - `_link` string: The unique URI of the AccuLynx custom field value.
    - `customFieldDefinition` CustomFieldDefinition
      - `id` string, uuid: The unique unique identifier of the AccuLynx custom field.
      - `_link` string: The unique URI of the AccuLynx custom field.
    - `label` string
    - `fieldType` 'Text' | 'Number' | 'Date' | 'Boolean': Specifies the data type (text, number, date, boolean) for the custom field.
    - `values` CustomFieldValueItem[]
      - `id` string, uuid: The unique identifier of the AccuLynx custom field item.
      - `value` string: The item value of the custom field
    - `modifiedBy` CompanyUserLink
      - `id` string, uuid: The unique GUID of the AccuLynx User.
      - `_link` string: The unique URI of the AccuLynx User.
    - `modifiedDate` string: The date/time the custom field was modified, in UTC format.

## Other responses

- `400`: The request was malformed or contained invalid field values. Check the error response body for details.
- `401`: The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.
- `403`: The API key does not have permission to perform this operation. Contact your administrator to request the required access.
- `404`: The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.

## Changes

- **2026-11-03** `443924b00f43`: 1 breaking
  - for the `query` request parameter `pageSize`, default value `25` was removed

[Operation history](https://skmtc.dev/acculynx/apis/acculynx-api-v2/changes/jobs/:jobId/custom-fields/get.md)

---

[API](https://skmtc.dev/acculynx/apis/acculynx-api-v2.md) - [All operations](https://skmtc.dev/acculynx/apis/acculynx-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/acculynx-api-v2/revisions/443924b00f43?raw)