Skip to main content
POST
/
fields
Create a field definition
curl --request POST \
  --url https://slog.ai/fields \
  --header 'Content-Type: application/json' \
  --header 'slog-api-key: <api-key>' \
  --data '
{
  "key": "sprint_points",
  "name": "Sprint Points",
  "type": "number",
  "description": "Story-point estimate for sprint planning.",
  "recordTypes": [
    "task"
  ]
}
'
{
  "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.

Body

application/json
​
key
string
required

Unique identifier within the workspace. Must start with a lowercase letter and contain only lowercase letters, digits, and underscores.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_]*$
Example:

"sprint_points"

​
name
string
required
Minimum string length: 1
Example:

"Sprint Points"

​
type
enum<string>
required
Available options:
text,
number,
boolean,
date,
datetime,
select,
multiSelect,
markdown,
fractionalIndex,
resourceId
Example:

"number"

​
description
string | null
Example:

"Story-point estimate for sprint planning."

​
presentation
string | null

Optional rendering hint for UI clients.

Example:

null

​
metadata
object

Type-specific metadata. For select/multiSelect fields, provide a choices array of allowed string values.

Example:
{}
​
recordTypes
string[]

Resource types this field applies to.

Example:
["task"]

Response

Field definition created.

​
field
object