Get custom field group details

Retrieves comprehensive custom field group information, including fields and values. Requires access to the board/card.

get/custom-field-groups/{id}

Request

Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
URL: /api/custom-field-groups/{id}
Auth: one of:
- HTTP bearer
- API key in header X-Api-Key

Path parameters

idstring required

Example:1357158568008091264

ID of the custom field group to retrieve

Response

Custom field group details retrieved successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "boardId": "1357158568008091265",
    "cardId": "1357158568008091266",
    "baseCustomFieldGroupId": "1357158568008091267",
    "position": 65536,
    "name": "Properties",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  },
  "included": {
    "customFields": [
      {
        "id": "1357158568008091264",
        "baseCustomFieldGroupId": "1357158568008091265",
        "customFieldGroupId": "1357158568008091266",
        "position": 65536,
        "name": "Priority",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ],
    "customFieldValues": [
      {
        "id": "1357158568008091264",
        "cardId": "1357158568008091265",
        "customFieldGroupId": "1357158568008091266",
        "customFieldId": "1357158568008091267",
        "content": "High Priority",
        "createdAt": "2024-01-01T00:00:00.000Z",
        "updatedAt": "2024-01-01T00:00:00.000Z"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.