Sign in
Custom Field

List custom field definitions

List custom-field definitions that apply at a scope, including inherited ancestors.

get/v1/custom-fields

Query parameters

scope_idstring required

Organization, namespace, or project ID that owns or inherits definitions.

scope_type'Assignment' | 'Attachment' | 'Comment' | 'Document' | 'Issue' | 'IssueRelation' | 'Label' | 'Namespace' | 'Notification' | 'Organization' | 'Permission' | 'Project' | 'ResourceType' | 'Role' | 'Team' | 'Todo' | 'User' | 'UserToken' | 'Folder' | 'Installation' | 'CustomFieldDefinition' | 'Extension' required
target_type'Assignment' | 'Attachment' | 'Comment' | 'Document' | 'Issue' | 'IssueRelation' | 'Label' | 'Namespace' | 'Notification' | 'Organization' | 'Permission' | 'Project' | 'ResourceType' | 'Role' | 'Team' | 'Todo' | 'User' | 'UserToken' | 'Folder' | 'Installation' | 'CustomFieldDefinition' | 'Extension' required
include_archivedboolean

Response

OK

idstring required
keystring required
namestring required
descriptionstring
kind'text' | 'integer' | 'decimal' | 'boolean' | 'date' | 'datetime' | 'url' | 'single_select' | 'multi_select' | 'user_reference' | 'resource_reference' required
scope_idstring required
scope_type'Assignment' | 'Attachment' | 'Comment' | 'Document' | 'Issue' | 'IssueRelation' | 'Label' | 'Namespace' | 'Notification' | 'Organization' | 'Permission' | 'Project' | 'ResourceType' | 'Role' | 'Team' | 'Todo' | 'User' | 'UserToken' | 'Folder' | 'Installation' | 'CustomFieldDefinition' | 'Extension' required
target_type'Assignment' | 'Attachment' | 'Comment' | 'Document' | 'Issue' | 'IssueRelation' | 'Label' | 'Namespace' | 'Notification' | 'Organization' | 'Permission' | 'Project' | 'ResourceType' | 'Role' | 'Team' | 'Todo' | 'User' | 'UserToken' | 'Folder' | 'Installation' | 'CustomFieldDefinition' | 'Extension' required
requiredboolean required
archivedboolean required
index_exactboolean required
index_rangeboolean required
index_fulltextboolean required
orderinteger required
owner_user_idstring required
registrar_client_idstring
created_atstring date-time
updated_atstring date-time nullable

Example response

[
  {
    "id": "9bsv0s46s6s002p9ltq0",
    "key": "story_points",
    "name": "Story points",
    "scope_id": "9bsv0s46s6s002p9ltq0",
    "schema": {
      "min": "0.01",
      "max": "100.00"
    }
  }
]

Changes

Changed in 2 of the 26 revisions of this API.33

  • 6c0b21e4101e32See the full diff
    • ●

      added the new Extension enum value to the //// response property for the response status

      response-property-enum-value-added

    • ●

      added the new Extension enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new Extension enum value to the / response property for the response status

      response-property-enum-value-added

    • ○

      added the new enum value Extension to the query request parameter scope_type

      request-parameter-enum-value-added

    • ○

      added the new enum value Extension to the query request parameter target_type

      request-parameter-enum-value-added

  • 605ffe113d3d1See the full diff
    • ○

      endpoint added

      endpoint-added