---
title: "Keys (fields and collections) of an extraction profile"
method: GET
path: "/extraction-profiles/{profileId}"
---

# Keys (fields and collections) of an extraction profile

`GET /extraction-profiles/{profileId}`

## Request

- Base URL: `/api/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/extraction-profiles/{profileId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/cdc/apis/zia-translation-service/docs/extraction-profiles/:profileId/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `profileId` string, required

## Response `200`

The profile

- ExtractionProfile
  - `id` string
  - `description` string
  - `fields` FieldDefinition[]
    - `key` string
    - `type` 'STRING' | 'DATE' | 'AMOUNT' | 'NUMBER' | 'IDENTIFIER' | 'ENUM'
    - `description` string
    - `values` string[]: Allowed values of an `ENUM` field
  - `collections` object[]
    - `key` string
    - `description` string
    - `fields` FieldDefinition[]
      - `key` string
      - `type` 'STRING' | 'DATE' | 'AMOUNT' | 'NUMBER' | 'IDENTIFIER' | 'ENUM'
      - `description` string
      - `values` string[]: Allowed values of an `ENUM` field

## Other responses

- `404`: Unknown profile

## Changes

- **2026-10-23** `db02012fc3ba`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cdc/apis/zia-translation-service/changes/extraction-profiles/:profileId/get.md)

---

[API](https://skmtc.dev/cdc/apis/zia-translation-service.md) - [All operations](https://skmtc.dev/cdc/apis/zia-translation-service/llms.txt) - [OpenAPI document](https://skmtc.dev/cdc/apis/zia-translation-service/revisions/17816f6177b4?raw)