Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Custom fields

Get custom fields on a project

get/v1/workspaces/{workspaceId}/projects/{projectId}/custom-fields

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

projectIdstring required

Represents a project identifier across the system.

Example:5b641568b07987035750505e

Represents a project identifier across the system.

Query parameters

status'INACTIVE' | 'VISIBLE' | 'INVISIBLE'

If provided, you'll get a filtered list of custom fields that matches the provided string with the custom field status.

entity-typestring

If provided, you'll get a filtered list of custom fields that matches the provided string with the custom field entity type.

Response

OK

allowedValuesstring[]

Represents a list of custom field's allowed values.

descriptionstring

Represents custom field description.

entityTypestring

Represents custom field entity type

idstring

Represents custom field identifier across the system.

namestring

Represents custom field name.

onlyAdminCanEditboolean

Flag to set whether custom field is modifiable only by admin users.

placeholderstring

Represents custom field placeholder value.

requiredboolean

Flag to set whether custom field is mandatory or not.

statusstring

Represents custom field status

typestring

Represents custom field type.

workspaceDefaultValueobject

Represents a custom field's default value in the workspace.

workspaceIdstring

Represents workspace identifier across the system.

Example response

[
  {
    "allowedValues": [
      "New York",
      "London",
      "Manila",
      "Sydney",
      "Belgrade"
    ],
    "description": "This field contains a location.",
    "entityType": "USER",
    "id": "44a687e29ae1f428e7ebe305",
    "name": "location",
    "placeholder": "Location",
    "projectDefaultValues": [
      {
        "projectId": "5b641568b07987035750505e",
        "status": "VISIBLE"
      }
    ],
    "status": "VISIBLE",
    "type": "DROPDOWN_MULTIPLE",
    "workspaceId": "64a687e29ae1f428e7ebe303"
  }
]