---
title: "List smart fields"
method: GET
path: "/v1/smart_fields"
tags: ["Smart Fields"]
---

# List smart fields

`GET /v1/smart_fields`

## Request

- Base URL: `https://api.scribe-mail.com`
- URL: `https://api.scribe-mail.com/v1/smart_fields`
- Auth: HTTP bearer

## Query parameters

- `integration_id` string
- `required` string
- `page` integer
- `per_page` integer

## Response `200`

Success

- ApiV1SmartFieldCollectionResponse
  - `data` object[], required
    - `id` string, required
    - `type` 'smart_field', required
    - `attributes` object, required
      - `label` string, required
      - `slug` string, required
      - `kind` string, required
      - `required` boolean, required
      - `position` integer, required
      - `data_source` object, nullable, required
        - `integration_id` string, required
        - `integration_kind` string, nullable
        - `integration_attribute` string, nullable
      - `completion` object, required
        - `total_teammates` integer, required
        - `filled` integer, required
        - `empty` integer, required
        - `completion_rate` number, required
  - `meta` ApiV1Meta, required
    - `request_id` string, required

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/scribe-mail/apis/scribe-public-api.md) · [All operations](https://skmtc.dev/scribe-mail/apis/scribe-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/scribe-mail/apis/scribe-public-api/revisions/2ab8476d37d5?raw)