---
title: "Get badge custom field by ID"
method: GET
path: "/api_gateway/v1/badges/customField/{customFieldId}"
---

# Get badge custom field by ID

`GET /api_gateway/v1/badges/customField/{customFieldId}`

## Path parameters

- `customFieldId` string, required

## Request body

- object
  - `name` string, required — Name of the custom field.
  - `isMandatory` string — Indicates if the custom field is mandatory.
  - `defaultValue` string — Default value of the custom field.
  - `isActive` string — Indicates if the update is currently active.
  - `dataType` 'INTEGER' | 'BOOLEAN' | 'DATE' | 'STRING', required — Data type of the custom field.

## Response `200`

200

- object
  - `data` object
    - `id` string
    - `orgId` integer
    - `name` string
    - `isMandatory` boolean
    - `defaultValue` string
    - `isActive` boolean
    - `dataType` string
    - `createdOn` number
    - `createdBy` integer
    - `lastUpdatedOn` number
    - `lastUpdatedBy` integer
  - `errors` unknown[]
    - unknown
  - `warnings` unknown[]
    - unknown

## Other responses

- `400` — 400

---

[API](https://skmtc.net/capillarytech/apis/sample-api.md) · [All operations](https://skmtc.net/capillarytech/apis/sample-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/capillarytech/sample-api/revisions/de241f2ed9b3/schema)