Skip to main content
GET
/
fields
/
{id}
Get a field definition
curl --request GET \
  --url https://slog.ai/fields/{id} \
  --header 'slog-api-key: <api-key>'
{
  "field": {
    "id": "fdef_01jqfield0001",
    "key": "sprint_points",
    "name": "Sprint Points",
    "description": "Story-point estimate for sprint planning.",
    "type": "number",
    "presentation": null,
    "metadata": {},
    "recordTypes": [
      "task"
    ],
    "isBuiltIn": false,
    "createdAt": "2026-05-01T10:00:00.000Z",
    "updatedAt": "2026-05-01T10:00:00.000Z"
  }
}

Authorizations

slog-api-key
string
header
required

API key obtained from the Slog dashboard or returned by the signup/invite-redeem flows. Pass as the slog-api-key header.

Path Parameters

id
string
required

Resource ID (UPID) or, for tasks and projects, the human-readable reference such as ENG-42.

Query Parameters

fields
string

Comma-separated list of fields to return. Supports brace notation for nested objects: fields=id,title,assignee{name,email}. When omitted, a default set of fields is returned.

Response

The field definition.

field
object