---
title: "Custom Fields"
method: GET
path: "/clubs/{club_id}/custom_fields"
tags: ["Custom Field"]
---

# Custom Fields

`GET /clubs/{club_id}/custom_fields`

## Request

- Base URL: `https://api.clubplatform.de/api`
- URL: `https://api.clubplatform.de/api/clubs/{club_id}/custom_fields`
- Auth: API key in query parameter `auth_token`

Returns a list of custom fields.

## Path parameters

- `club_id` integer, required

## Response `200`

OK

- object
  - `data` object[]: Array of custom fields.
    - `id` integer: Unique internal id.
    - `key` string: Unique identifier.
    - `value` string: Content of the key.
    - `category` string: Category for custom field.
    - `description` string: Description which explain how this key/value should be used.
    - `json_format` boolean: indicates if value should be a json. if true the field value is validated to be json

## Other responses

- `304`: Not Modified
- `401`: Unauthorized
- `404`: Not Found

---

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