> ## Documentation Index
> Fetch the complete documentation index at: https://help.statisfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List every field definition on an object (the describe API)

> Returns all standard and custom field definitions for an object (account, activity, contact, opportunity, project, task, user): key, label, type, picklist options, visibility and requiredness. Standard fields sit at the top level of a record and custom fields under `fields` — `kind` says which. The keys here are the vocabulary every filter and update uses. Each field says who owns its value (`owner`), whether an API update may write it (`writable`: its owner allows it and the API writes that field and object; false on objects the API does not update yet, though some take creates) and whether a write reaches the customer's CRM (`syncs_to_crm`). Owner fields and links such as an account's `parent` or a task's `project` are `reference` fields holding the id of one record of `object`; a task's `assignee` names no `object`, as it holds a user's or a contact's id (the record's `assignee_type` says which). Links to many records are listed under `relationships`. A tenant may have hundreds of custom fields: narrow the list with `kind`, `search` (text in the key or label) or `keys`, or read one field with GET /v1/fields/{field_key}.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/fields
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/fields:
    get:
      tags:
        - fields
      summary: List every field definition on an object (the describe API)
      description: >-
        Returns all standard and custom field definitions for an object
        (account, activity, contact, opportunity, project, task, user): key,
        label, type, picklist options, visibility and requiredness. Standard
        fields sit at the top level of a record and custom fields under `fields`
        — `kind` says which. The keys here are the vocabulary every filter and
        update uses. Each field says who owns its value (`owner`), whether an
        API update may write it (`writable`: its owner allows it and the API
        writes that field and object; false on objects the API does not update
        yet, though some take creates) and whether a write reaches the
        customer's CRM (`syncs_to_crm`). Owner fields and links such as an
        account's `parent` or a task's `project` are `reference` fields holding
        the id of one record of `object`; a task's `assignee` names no `object`,
        as it holds a user's or a contact's id (the record's `assignee_type`
        says which). Links to many records are listed under `relationships`. A
        tenant may have hundreds of custom fields: narrow the list with `kind`,
        `search` (text in the key or label) or `keys`, or read one field with
        GET /v1/fields/{field_key}.
      operationId: fields_list
      parameters:
        - description: >-
            The object the field belongs to: one of account, activity, contact,
            opportunity, project, task, user, or a custom object's key (GET
            /v1/objects lists them)
          in: query
          name: object
          required: true
          schema:
            type: string
        - description: Only standard or only custom fields
          in: query
          name: kind
          required: false
          schema:
            anyOf:
              - enum:
                  - standard
                  - custom
                type: string
              - type: 'null'
            default: null
        - description: Only fields whose key or label contains this text
          in: query
          name: search
          required: false
          schema:
            anyOf:
              - maxLength: 200
                minLength: 1
                type: string
              - type: 'null'
            default: null
        - description: Only these keys, comma-separated (`keys=a,b`)
          explode: false
          in: query
          name: keys
          required: false
          schema:
            anyOf:
              - items:
                  type: string
                type: array
              - type: 'null'
            default: null
          style: form
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldsListResponse'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    FieldsListResponse:
      properties:
        fields:
          items:
            $ref: '#/components/schemas/FieldDef'
          title: Fields
          type: array
        object:
          title: Object
          type: string
        relationships:
          items:
            $ref: '#/components/schemas/RelationshipDef'
          title: Relationships
          type: array
      required:
        - object
        - fields
      title: FieldsListResponse
      type: object
    FieldDef:
      properties:
        currency_code:
          anyOf:
            - type: string
            - type: 'null'
          title: Currency Code
        formula:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          description: >-
            Set on a formula field: how its value is computed, in the shape
            `formula` takes on POST /v1/fields
          title: Formula
        hidden:
          default: false
          title: Hidden
          type: boolean
        key:
          title: Key
          type: string
        kind:
          enum:
            - standard
            - custom
          title: Kind
          type: string
        label:
          title: Label
          type: string
        mandatory:
          default: false
          title: Mandatory
          type: boolean
        object:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The object whose id(s) the value holds: set on reference fields (one
            id) and on id lists such as a contact's accounts (type text_list)
          title: Object
        option_labels:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: 'null'
          title: Option Labels
        options:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Options
        owner:
          default: statisfy
          enum:
            - statisfy
            - crm
            - warehouse
            - integration
            - ai
            - computed
          title: Owner
          type: string
        syncs_to_crm:
          default: false
          title: Syncs To Crm
          type: boolean
        type:
          title: Type
          type: string
        writable:
          default: false
          title: Writable
          type: boolean
      required:
        - key
        - label
        - type
        - kind
      title: FieldDef
      type: object
    RelationshipDef:
      description: >-
        A link to many records of another object, set on the record that holds
        it.
      properties:
        key:
          title: Key
          type: string
        object:
          title: Object
          type: string
        set_from:
          title: Set From
          type: string
      required:
        - key
        - object
        - set_from
      title: RelationshipDef
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.