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

# List auto-fill agents

> List AI auto-fill agents (offset pagination, newest first). **Requires scope:** `property_agents:read`.



## OpenAPI

````yaml /openapi-v1.json get /v1/property-agents
openapi: 3.1.0
info:
  title: Custral API
  version: v1
  description: >-
    The curated, versioned, API-key-authenticated public REST surface (`/v1`).
    Every endpoint here is what the official SDKs (`@custral/sdk`) and the MCP
    server are built on. Authenticate with a secret API key (`sk_…`) created in
    **Settings → Applications**.
  contact:
    name: Custral Support
    email: hello@custral.com
    url: https://custral.com
  license:
    name: Proprietary
    url: https://custral.com
servers:
  - url: https://api.custral.com
    description: Production
security:
  - ApiKey: []
tags:
  - name: Identity
    description: Introspect the calling API key.
  - name: Records
    description: Create, list, retrieve, and update records on any object.
  - name: Objects
    description: Read the object (table) schema of your workspace.
  - name: Conversations
    description: View, manage, and ingest conversations and their messages.
  - name: MCP
    description: Introspect the Model Context Protocol tool surface for a key.
  - name: Documents
    description: Read record notes / page documents as markdown.
paths:
  /v1/property-agents:
    get:
      tags:
        - Property agents
      summary: List auto-fill agents
      description: >-
        List AI auto-fill agents (offset pagination, newest first). **Requires
        scope:** `property_agents:read`.
      operationId: listPropertyAgents
      parameters:
        - name: limit
          in: query
          required: false
          description: How many to return (1–200).
          schema:
            type: integer
            default: 50
        - name: offset
          in: query
          required: false
          description: How many to skip.
          schema:
            type: integer
            default: 0
        - name: objectId
          in: query
          required: false
          description: Filter to auto-fills on a single object (`obj_…`).
          schema:
            type: string
      responses:
        '200':
          description: A page of auto-fill agents.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PropertyAgentList'
                  reqId:
                    $ref: '#/components/schemas/RequestId'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    PropertyAgentList:
      type: object
      description: A page of auto-fill agents.
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PropertyAgent'
        total:
          type:
            - integer
            - 'null'
        limit:
          type: integer
        offset:
          type: integer
      required:
        - data
    RequestId:
      type: string
      description: >-
        A per-request id (`req_…`). Quote it to support when reporting a
        problem.
      example: req_2a1f9c8e7b6d5
    PropertyAgent:
      type: object
      description: >-
        An AI auto-fill agent — the config attached to a single property that
        fills its value with AI.
      properties:
        id:
          type: string
          example: pagent_123
        objectId:
          type:
            - string
            - 'null'
          example: obj_123
        propertyId:
          type:
            - string
            - 'null'
          example: prop_123
        kind:
          type:
            - string
            - 'null'
          enum:
            - summarize
            - research
            - classify
            - prompt
            - null
          example: research
        instructions:
          type:
            - string
            - 'null'
          example: Using the record's Website, output the company's industry.
        model:
          type:
            - string
            - 'null'
          example: auto
        sources:
          type: object
          description: Context toggles the agent reads from.
          additionalProperties: true
        triggerTypes:
          type: array
          items:
            type: string
            enum:
              - onCreate
              - onUpdate
              - recurring
        recurringCron:
          type:
            - string
            - 'null'
        scopeFilterJson:
          description: >-
            An optional record filter restricting which records the agent fires
            on, or null.
        dependsOn:
          type: array
          items:
            type: string
          description: propertyIds that must run before this agent.
        requiresProperties:
          type: array
          items:
            type: string
          description: propertyIds that must be non-empty before this agent runs.
        onlyIfEmpty:
          type: boolean
        isEnabled:
          type: boolean
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
      required:
        - id
    Error:
      type: object
      description: >-
        The failure envelope. Every error carries a machine-readable `code` and
        the `reqId` of the failing request.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: insufficient_scope
          required:
            - code
        reqId:
          $ref: '#/components/schemas/RequestId'
      required:
        - error
  responses:
    Unauthorized:
      description: >-
        The API key is missing, unknown, inactive, or expired (`code:
        invalid_api_key`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: invalid_api_key
            reqId: req_2a1f9c8e7b6d5
    Forbidden:
      description: >-
        The key lacks the scope this endpoint requires (`code:
        insufficient_scope`).
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: insufficient_scope
            reqId: req_2a1f9c8e7b6d5
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: sk_...
      description: >-
        A Custral **secret** API key (`sk_…`), created in Settings →
        Applications. Sent as `Authorization: Bearer sk_…`. The `X-Api-Key:
        sk_…` header is also accepted and takes precedence. Never expose a
        secret key in a browser.

````

## Related topics

- [Delete an auto-fill agent](/api-reference/property-agents/delete-an-auto-fill-agent.md)
- [Retrieve an auto-fill agent](/api-reference/property-agents/retrieve-an-auto-fill-agent.md)
- [Update an auto-fill agent](/api-reference/property-agents/update-an-auto-fill-agent.md)
- [Property Auto-Fill Agents](/ai/property-agents/overview.md)
- [The Property Agent object](/dev/api-reference/property-agents.md)