Skip to main content
GET
/
api
/
v1
/
workspaces
/
{id}
/
custom-fields
List custom fields
curl --request GET \
  --url https://api.getarca.app/api/v1/workspaces/{id}/custom-fields \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 1,
    "name": "Customer Tier",
    "type": "dropdown",
    "config": { "options": ["Free", "Starter", "Pro"] },
    "position": 1,
    "is_scope_restricted": false,
    "granted_folder_ids": [],
    "list_overrides": []
  },
  {
    "id": 2,
    "name": "Story Points",
    "type": "number",
    "config": null,
    "position": 2,
    "is_scope_restricted": true,
    "granted_folder_ids": [4],
    "list_overrides": []
  },
  {
    "id": 3,
    "name": "Satisfaction",
    "type": "rating",
    "config": { "iconName": "star-filled", "color": "yellow" },
    "position": 3,
    "is_scope_restricted": true,
    "granted_folder_ids": [],
    "list_overrides": [{ "list_id": 12, "access": "granted" }]
  }
]
Requires the tasks:read scope. You must be a member of the workspace. Fields with restricted access are automatically filtered; owners and admins always receive all fields.

​
Path parameters

​
id
string
required
The numeric workspace ID.

​
Response

Returns an array of custom field objects ordered by position ascending.
​
id
number
required
Custom field identifier.
​
name
string
required
Display name of the custom field (e.g., "Customer Tier").
​
type
string
required
Field type. One of text, number, date, checkbox, rating, dropdown, money, or people.
​
config
object | null
Type-specific configuration object. null for types with no configuration.
​
position
number
required
Sort position within the workspace (ascending).
​
is_scope_restricted
boolean
required
When false, the field is available on all lists in the workspace. When true, the field is only available on lists covered by granted_folder_ids and list_overrides.
​
granted_folder_ids
number[]
required
Folder IDs where this field applies when is_scope_restricted is true. All lists inside a granted folder inherit the field unless overridden.
​
list_overrides
array
required
Explicit list-level overrides when is_scope_restricted is true. Each entry has list_id (number) and access (granted or denied). A denied entry hides the field on that list even if its folder is granted.
Task responses (GET /tasks/:id, list tasks, etc.) only include custom fields that apply to the task’s list. Values for inapplicable fields are not returned, and writes to those fields are ignored.
[
  {
    "id": 1,
    "name": "Customer Tier",
    "type": "dropdown",
    "config": { "options": ["Free", "Starter", "Pro"] },
    "position": 1,
    "is_scope_restricted": false,
    "granted_folder_ids": [],
    "list_overrides": []
  },
  {
    "id": 2,
    "name": "Story Points",
    "type": "number",
    "config": null,
    "position": 2,
    "is_scope_restricted": true,
    "granted_folder_ids": [4],
    "list_overrides": []
  },
  {
    "id": 3,
    "name": "Satisfaction",
    "type": "rating",
    "config": { "iconName": "star-filled", "color": "yellow" },
    "position": 3,
    "is_scope_restricted": true,
    "granted_folder_ids": [],
    "list_overrides": [{ "list_id": 12, "access": "granted" }]
  }
]