> ## Documentation Index > Fetch the complete documentation index at: https://docs.slog.ai/llms.txt > Use this file to discover all available pages before exploring further. # List field definitions > Returns all field definitions visible in the current workspace, including built-in fields (returned first, before cursor-based custom fields). Built-in fields reflect the intrinsic properties of each resource type (e.g. `title`, `status`, `dueDate`) and are useful for building generic UIs that enumerate queryable columns. They do not have an `id` and `isBuiltIn` is `true`. Filter by `recordType` to restrict results to a specific resource type: ``` filter[eq][recordType]=task ``` ## OpenAPI ````yaml /api/openapi.yaml get /fields openapi: 3.1.0 info: title: Slog API version: 1.0.0 description: > Slog is an AI-native project management tool. This reference covers the core REST API for managing tasks, projects, teams, milestones, workspaces, and invites. ## Authentication All authenticated endpoints accept either an **API key** (header `slog-api-key`) or a **Bearer token** (header `Authorization: Bearer `). Tokens are returned by the signup, invite-redeem, and OAuth flows. API keys can be created in the Slog dashboard. ## Field selection Every list and get endpoint accepts a `fields` query parameter to control which fields are returned. Use comma-separated field names; nested objects can be selected with brace notation: ``` fields=id,title,status,assignee{name,email} ``` When omitted, a default set of fields is returned for each resource. ## Filtering List endpoints support structured filters using bracket notation: ``` filter[eq][status]=TODO filter[contains][title]=auth filter[in][status]=TODO&filter[in][status]=IN_PROGRESS filter[gte][dueDate]=2026-01-01 ``` Supported operators: `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `contains`, `startsWith`, `in`. ## Sorting ``` sort[createdAt]=desc sort[title]=asc ``` ## Pagination List endpoints use cursor-based pagination. Pass the `nextCursor` from the previous response as the `cursor` parameter to fetch the next page. A `null` nextCursor means you've reached the end. contact: url: https://slog.ai servers: - url: https://slog.ai description: Production - url: http://localhost:3020 description: Local development security: - ApiKey: [] - BearerToken: [] tags: - name: Health description: Liveness check. No authentication required. - name: Authentication description: Sign up, log in, and inspect the current user. - name: Tasks description: > Tasks are the primary unit of work. They belong to a team and optionally to a project. Subtasks are created by setting `parentId` on the child task. Each task gets a human-readable reference code like `ENG-42` derived from its team prefix. - name: Projects description: Projects group related tasks within a team and can contain milestones. - name: Teams description: > Teams are the organizational unit that owns tasks and projects. Each team has a short prefix (e.g. `ENG`) used to generate task and project reference codes. Teams can be nested via `parentId`. - name: Milestones description: Milestones represent time-boxed goals. They live under a project. - name: Workspaces description: >- A workspace is the top-level container. Users belong to one or more workspaces. - name: Invites description: Invite new members to a workspace by email. - name: Agents description: Create and manage AI agent users within a workspace. - name: API Keys description: Manage API keys for the current user and their owned agents. - name: Fields description: > Custom field definitions for extending resource types. Built-in fields (id, title, status, etc.) are automatically included in list responses. Custom fields are workspace-scoped and can target one or more resource types. - name: Batch description: Fetch multiple resources in a single round-trip. - name: Search description: > Unified, cross-resource text search over tasks, projects, and milestones using a single human-friendly query syntax. See the Search guide for the full grammar. - name: Import/Export description: Export a resource to a portable format and import it back. - name: Comments description: Comments can be added to tasks, projects, or milestones. - name: Labels description: >- Labels are workspace-scoped tags that can be attached to tasks and projects. - name: Team Members description: Manage team membership and roles. - name: Users description: User accounts within the workspace. paths: /fields: get: tags: - Fields summary: List field definitions description: > Returns all field definitions visible in the current workspace, including built-in fields (returned first, before cursor-based custom fields). Built-in fields reflect the intrinsic properties of each resource type (e.g. `title`, `status`, `dueDate`) and are useful for building generic UIs that enumerate queryable columns. They do not have an `id` and `isBuiltIn` is `true`. Filter by `recordType` to restrict results to a specific resource type: ``` filter[eq][recordType]=task ``` operationId: listFields parameters: - $ref: '#/components/parameters/FieldsParam' - $ref: '#/components/parameters/LimitParam' - $ref: '#/components/parameters/CursorParam' - $ref: '#/components/parameters/FilterParam' - $ref: '#/components/parameters/SortParam' responses: '200': description: A page of field definitions. content: application/json: schema: $ref: '#/components/schemas/FieldDefinitionListResponse' example: fields: - key: title name: title description: null type: text presentation: null metadata: {} recordTypes: - task - project - milestone isBuiltIn: true - 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' pagination: limit: 50 nextCursor: null '401': $ref: '#/components/responses/Unauthorized' components: parameters: FieldsParam: name: fields in: query required: false schema: type: string description: > 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. example: id,title,status,assignee{name} LimitParam: name: limit in: query required: false schema: type: integer minimum: 1 maximum: 250 default: 50 description: Maximum number of results to return per page. CursorParam: name: cursor in: query required: false schema: type: string description: > Opaque cursor from the `nextCursor` field of a previous response. Pass this to fetch the next page. FilterParam: name: filter in: query required: false style: deepObject explode: true schema: type: object additionalProperties: type: object additionalProperties: oneOf: - type: string - type: array items: type: string description: > Structured filter using bracket notation: `filter[][]=`. Supported operators: - `eq` — equals - `neq` — not equals - `gt` / `gte` — greater than / greater than or equal - `lt` / `lte` — less than / less than or equal - `contains` — case-insensitive substring match - `startsWith` — case-insensitive prefix match - `in` — one of (repeat the parameter for multiple values) Examples: ``` filter[eq][status]=TODO filter[contains][title]=auth filter[in][status]=TODO&filter[in][status]=IN_PROGRESS filter[gte][dueDate]=2026-01-01 ``` SortParam: name: sort in: query required: false style: deepObject explode: true schema: type: object additionalProperties: type: string enum: - asc - desc description: | Sort using bracket notation: `sort[]=asc|desc`. Example: `sort[createdAt]=desc` schemas: FieldDefinitionListResponse: type: object properties: fields: type: array items: $ref: '#/components/schemas/FieldDefinition' pagination: $ref: '#/components/schemas/Pagination' FieldDefinition: type: object properties: id: type: string nullable: true description: UPID for custom fields. `null` for built-in fields. example: fdef_01jqfield0001 key: type: string description: > Unique snake_case identifier within the workspace. Immutable after creation. example: sprint_points name: type: string description: Human-readable display name. example: Sprint Points description: type: string nullable: true example: Story-point estimate for sprint planning. type: type: string enum: - text - number - boolean - date - datetime - select - multiSelect - markdown - fractionalIndex - resourceId - Record description: > Value type. Built-in fields that reference related records use `Record`. Immutable after creation. example: number presentation: type: string nullable: true description: Optional rendering hint for UI clients. example: null metadata: type: object description: | Type-specific metadata. For `select`/`multiSelect` fields, provide a `choices` array of allowed string values. example: {} recordTypes: type: array items: type: string description: Resource types this field applies to (e.g. `task`, `project`). example: - task isBuiltIn: type: boolean description: > `true` for fields derived from the resource schema. Built-in fields cannot be deleted or mutated and have no `id`, `createdAt`, or `updatedAt`. example: false createdAt: type: string format: date-time nullable: true description: Present only on custom (non-built-in) fields. example: '2026-05-01T10:00:00.000Z' updatedAt: type: string format: date-time nullable: true description: Present only on custom (non-built-in) fields. example: '2026-05-01T10:00:00.000Z' Pagination: type: object properties: limit: type: integer example: 50 nextCursor: type: string nullable: true description: >- Pass this value as `cursor` to fetch the next page. `null` means no more pages. example: null ErrorBody: type: object properties: error: type: object properties: code: type: string example: NOT_FOUND message: type: string example: Task not found details: type: object additionalProperties: true description: Additional error context, if any. responses: Unauthorized: description: Missing or invalid authentication credentials. content: application/json: schema: $ref: '#/components/schemas/ErrorBody' example: error: code: UNAUTHORIZED message: Authentication required securitySchemes: ApiKey: type: apiKey in: header name: slog-api-key description: > API key obtained from the Slog dashboard or returned by the signup/invite-redeem flows. Pass as the `slog-api-key` header. BearerToken: type: http scheme: bearer bearerFormat: JWT description: | JWT obtained from an OAuth callback or the CLI device-flow. Pass as `Authorization: Bearer `. ````