---
title: "Get a smart field"
method: GET
path: "/v1/smart_fields/{uuid}"
tags: ["Smart Fields"]
---

# Get a smart field

`GET /v1/smart_fields/{uuid}`

## Request

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

## Path parameters

- `uuid` string, required

## Response `200`

Success

- ApiV1SmartFieldResponse
  - `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

- `404`: Not found

---

[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)