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
  },
  {
    "id": 2,
    "name": "Story Points",
    "type": "number",
    "config": null,
    "position": 2
  },
  {
    "id": 3,
    "name": "Satisfaction",
    "type": "rating",
    "config": { "iconName": "star-filled", "color": "yellow" },
    "position": 3
  }
]
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).
[
  {
    "id": 1,
    "name": "Customer Tier",
    "type": "dropdown",
    "config": { "options": ["Free", "Starter", "Pro"] },
    "position": 1
  },
  {
    "id": 2,
    "name": "Story Points",
    "type": "number",
    "config": null,
    "position": 2
  },
  {
    "id": 3,
    "name": "Satisfaction",
    "type": "rating",
    "config": { "iconName": "star-filled", "color": "yellow" },
    "position": 3
  }
]