---
title: "Retrieve active and archived subscriber field schema."
method: GET
path: "/fields/archive"
tags: ["Fields"]
---

# Retrieve active and archived subscriber field schema.

`GET /fields/archive`

## Request

- Base URL: `https://api.maildroppa.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.maildroppa.com/fields/archive`
- Auth: API key in header `X-API-Key`

Returns built-in, active, and archived subscriber fields for explicit archive contexts.

## Response `200`

Archive field schema retrieved.

- FieldCatalog: Subscriber field schema containing built-in and customer-created fields.
  - `fields` Field[]: Subscriber fields ordered by position.
    - `type` 'BUILT_IN' | 'CUSTOM'
    - `builtInField` 'EMAIL' | 'FIRST_NAME'
    - `fieldId` string, uuid
    - `personalizationTagName` string: Stable personalization tag name used in imports, forms, personalization, and subscriber field value updates.
    - `label` string: Human-readable field label shown in the app.
    - `fieldType` 'TEXT' | 'LONG_TEXT' | 'EMAIL' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'SINGLE_CHOICE' | 'MULTI_CHOICE'
    - `required` boolean: Whether subscribers must provide a value for this field in signup and subscriber edit workflows.
    - `internal` boolean: Whether this field is hidden from subscriber-facing forms and subscriber profile editing.
    - `active` boolean: False when a customer-created field has been archived.
    - `position` integer: Ordering position in the field schema.
    - `options` FieldOption[]: Selectable options for SINGLE_CHOICE and MULTI_CHOICE fields.
      - `id` string, uuid
      - `label` string: Human-readable option label.
      - `position` integer: Ordering position within the field options.
      - `active` boolean: Whether the option can still be selected for new subscriber field values.

## Other responses

- `401`: Not Authorized
- `403`: Not Allowed
- `428`: Accept the customer agreements in the app before using API keys.

---

[API](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta.md) · [All operations](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta/llms.txt) · [OpenAPI document](https://skmtc.dev/maildroppa/apis/maildroppa-api-beta/revisions/a9f5a3fd1fb0?raw)