---
title: "Get External Entity Schema"
method: GET
path: "/v2/entity-ingestion-configs/{ingestion_config_id}/external-schema"
tags: ["Entity Field Mapping API"]
---

# Get External Entity Schema

`GET /v2/entity-ingestion-configs/{ingestion_config_id}/external-schema`

## Request

- Base URL: `https://public.api.serval.com`
- URL: `https://public.api.serval.com/v2/entity-ingestion-configs/{ingestion_config_id}/external-schema`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/serval/apis/serval-public-api/docs/v2/entity-ingestion-configs/:ingestion_config_id/external-schema/get.ts> (a function with typed inputs; its response is checked against the schema)

Get the external schema discovered from the most recent sync of an ingestion config. Its json_schema lists the external field paths available to map into entity-type fields.

## Path parameters

- `ingestion_config_id` string, required: The ingestion config whose discovered external schema to read.

## Response `200`

Success

- SvstorePublicapiGetExternalEntitySchemaResponse
  - `data` SvstoreExternalEntitySchema: External asset schema extracted from ingested data
    - `id` string
    - `ingestionConfigId` string: Set when this schema was produced by an asset ingestion config. Mutually exclusive with svflow_user_ingestion_config_id.
    - `jsonSchema` GoogleProtobufStruct: `Struct` represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, `Struct` might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language. The JSON representation for `Struct` is JSON object.
    - `sampleSize` integer
    - `totalAssetsSampled` integer
    - `extractedAt` string, date-time: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
    - `inference` SvstoreEntityMappingInference
      - `inferredEntityTypeId` string, nullable
      - `fieldMappings` SvstoreInferredFieldMapping[]
        - `externalFieldPath` string
        - `internalFieldId` string
      - `reasoning` string
    - `entityCount` integer
    - `sourceAppInstanceId` string
    - `svflowUserIngestionConfigId` string, nullable: Set when this schema was produced by a user ingestion config in svflow. Mutually exclusive with ingestion_config_id.

## Other responses

- `default`: Error

---

[API](https://skmtc.dev/serval/apis/serval-public-api.md) - [All operations](https://skmtc.dev/serval/apis/serval-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/serval/apis/serval-public-api/revisions/0549515e9384?raw)