Custom Fields

8 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1

List custom fields for the current organization#

GET/custom-fieldsToken

Parameter

Name	Ort	Typ	Beschreibung
`spaceId`	Query	`string`	UUID of space (returns org + space fields)
`field_type`	Query	`string`	Filter by field type (text, number, select, etc.)
`is_active`	Query	`string`	true or false
`search`	Query	`string`	Search in name or description
`is_deleted`	Query	`string`	true to fetch deleted fields
`context`	Query	`string`	Filter by context (task, process, etc.)
`scope`	Query	`string`	organization or space

Antworten

200Custom fields returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/custom-fields" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Create a custom field#

POST/custom-fieldsToken

Request-Body`application/jsonCreateCustomFieldDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	Beispiel: `Priority`
`field_key`	`string`	Unique field key within the organization. Auto-generated if omitted. Beispiel: `priority`
`field_type`Pflicht	`string`	Werte: `stringnumbereditorselectmultiselectuser_selectuser_multicheckboxradiolabeldatetimedatetimeurlcascading_selectwiki_pagetasklist_itemlist_item_multigrid`
`scope`	`string`	Werte: `organizationspace`
`space_id`	`object`	–
`description`	`object`	–
`name_i18n`	`object`	–
`description_i18n`	`object`	–
`default_value`	`object`	–
`options`	`object[]`	–
`validation_rules`	`object`	–
`contexts`	`string[]`	–
`is_active`	`boolean`	–
`sort_order`	`number`	–
`organizationId`	`string`	Ignored — org comes from auth token

Antworten

201Custom field created

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/custom-fields" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Priority","field_type":"string"}'

Get a custom field by id#

GET/custom-fields/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200Custom field returned

Beispiel (cURL)

curl -X GET "https://xapi.ambertech.cloud/api/v1/custom-fields/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Update a custom field#

PUT/custom-fields/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonUpdateCustomFieldDto`

Name	Typ	Beschreibung
`id`	`string`	–
`field_type`	`string`	–
`field_key`	`string`	–
`name`	`string`	–
`description`	`object`	–
`name_i18n`	`object`	–
`description_i18n`	`object`	–
`default_value`	`object`	–
`options`	`FieldOptionDto[]`	–
`validation_rules`	`object`	–
`contexts`	`string[]`	–
`is_active`	`boolean`	–
`sort_order`	`number`	–

Antworten

200Custom field updated

Beispiel (cURL)

curl -X PUT "https://xapi.ambertech.cloud/api/v1/custom-fields/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"…","field_type":"…","field_key":"…"}'

Perform a maintenance action (toggle_active, restore, permanent_delete)#

PATCH/custom-fields/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Request-Body`application/jsonPatchCustomFieldDto`

Name	Typ	Beschreibung
`action`Pflicht	`string`	Werte: `toggle_activerestorepermanent_delete`
`is_active`	`boolean`	Required when action is `toggle_active`; new `is_active` value.

Antworten

200Action applied

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/custom-fields/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"action":"toggle_active"}'

Soft delete a custom field#

DELETE/custom-fields/{id}Token

Parameter

Name	Ort	Typ	Beschreibung
`id`Pflicht	Pfad	`string`	–

Antworten

200Custom field soft-deleted

Beispiel (cURL)

curl -X DELETE "https://xapi.ambertech.cloud/api/v1/custom-fields/{id}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Generate a unique field key for a given name#

POST/custom-fields/generate-keyToken

Request-Body`application/jsonGenerateKeyDto`

Name	Typ	Beschreibung
`name`Pflicht	`string`	Beispiel: `Business Impact`
`space_id`	`object`	Optional space id for scoped uniqueness. Org-level keys still shadow all spaces.
`organizationId`	`string`	Ignored — org comes from auth token

Antworten

200Returns `{ field_key }`

Beispiel (cURL)

curl -X POST "https://xapi.ambertech.cloud/api/v1/custom-fields/generate-key" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Business Impact"}'

Bulk reorder custom fields#

PATCH/custom-fields/reorderToken

Request-Body`application/jsonReorderCustomFieldsDto`

Name	Typ	Beschreibung
`field_orders`Pflicht	`CustomFieldOrderDto[]`	–
`field_orders[].assignment_id`Pflicht	`string`	–
`field_orders[].sort_order`Pflicht	`number`	–

Antworten

200Custom fields reordered

Beispiel (cURL)

curl -X PATCH "https://xapi.ambertech.cloud/api/v1/custom-fields/reorder" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"field_orders":[]}'

Custom Fields

List custom fields for the current organization#

Parameter

Antworten

Create a custom field#

Request-Bodyapplication/jsonCreateCustomFieldDto

Antworten

Get a custom field by id#

Parameter

Antworten

Update a custom field#

Parameter

Request-Bodyapplication/jsonUpdateCustomFieldDto

Antworten

Perform a maintenance action (toggle_active, restore, permanent_delete)#

Parameter

Request-Bodyapplication/jsonPatchCustomFieldDto

Antworten

Soft delete a custom field#

Parameter

Antworten

Generate a unique field key for a given name#

Request-Bodyapplication/jsonGenerateKeyDto

Antworten

Bulk reorder custom fields#

Request-Bodyapplication/jsonReorderCustomFieldsDto

Antworten

Request-Body`application/jsonCreateCustomFieldDto`

Request-Body`application/jsonUpdateCustomFieldDto`

Request-Body`application/jsonPatchCustomFieldDto`

Request-Body`application/jsonGenerateKeyDto`

Request-Body`application/jsonReorderCustomFieldsDto`