---
title: "Listing custom fields of a job"
method: GET
path: "/jobs/{jobId}/custom-fields"
tags: ["Jobs"]
---

# Listing custom fields of a job

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

## Request

- Base URL: `https://api.gupy.io/api/v1`
- URL: `https://api.gupy.io/api/v1/jobs/{jobId}/custom-fields`
- Auth: HTTP bearer

Returns a list of custom fields of a job.

## Path parameters

- `jobId` integer, required

## Response `200`

An array of job custom fields

- JobCustomFields: An array of job custom field
  - `results` JobCustomField[], required
    - `id` string: Custom field id
    - `label` string: Custom field label
    - `value` union: Custom field provided value
      - string
      - string[]
    - `type` 'select' | 'multiSelect' | 'text' | 'boolean' | 'number' | 'date' | 'time': Custom field type
    - `order` integer: Custom field order of appearance when editing a job
    - `required` boolean: Informs if this custom field response is mandatory
    - `enum` string[]: Possible options to be provided as value
  - `totalResults` integer
  - `page` integer
  - `totalPages` integer

## Other responses

- `400`: BadRequest / Invalid Input
- `401`: Unauthorized
- `403`: Forbidden

---

[API](https://skmtc.dev/gupy/apis/gupy-public-api.md) - [All operations](https://skmtc.dev/gupy/apis/gupy-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gupy/apis/gupy-public-api/revisions/b84c14658872?raw)