> For the complete documentation index, see [llms.txt](https://api-docs.helloaviary.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.helloaviary.ai/mappings.md).

# Mappings

Retrieve client and use-case column mappings keyed by API key. Served from `/getMapping`.

## Get Mapping

> Retrieves all use cases and their column mappings for the client associated with the provided API key

```json
{"openapi":"3.0.3","info":{"title":"Aviary v1 API (merged — Osprey v1 + legacy clientApi)","version":"1.0.0"},"tags":[{"name":"Mappings","description":"Retrieve client and use-case column mappings\nkeyed by API key. Served from `/getMapping`.\n"}],"servers":[{"url":"https://osprey.helloaviary.com/api","description":"Production"},{"url":"https://osprey-dev.helloaviary.com/api","description":"Development"}],"security":[{"ApiKeyAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"API key for authentication"}},"schemas":{"GetMappingResponse":{"type":"object","required":["message","clientName","listOfUseCaseNamesAndValues"],"properties":{"message":{"type":"string"},"clientName":{"type":"string","description":"The client name associated with the API key"},"listOfUseCaseNamesAndValues":{"type":"array","items":{"$ref":"#/components/schemas/ColumnMapping"}}}},"ColumnMapping":{"type":"object","required":["useCaseName","columnValues"],"properties":{"useCaseName":{"type":"string","nullable":true,"description":"The name of the use case"},"columnValues":{"type":"array","items":{"type":"string"},"description":"Array of column name mappings for this use case"}}},"ErrorResponse":{"type":"object","required":["message"],"description":"Legacy clientApi error shape. Distinct from `ErrorEnvelope` —\nthe legacy routes return a flat `{message, error?}` payload\nwithout a stable code or request_id.\n","properties":{"message":{"type":"string","description":"Error message"},"error":{"type":"string","description":"Detailed error information"}}}}},"paths":{"/getMapping":{"get":{"summary":"Get Mapping","description":"Retrieves all use cases and their column mappings for the client associated with the provided API key","operationId":"getMapping","tags":["Mappings"],"parameters":[],"responses":{"200":{"description":"Successfully retrieved client mappings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMappingResponse"}}}},"404":{"description":"API key or client not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Database connection error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://api-docs.helloaviary.ai/mappings.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.