---
title: "Get Data Map by ID"
method: GET
path: "/data_maps/{data_map_id}"
tags: ["Data Maps"]
---

# Get Data Map by ID

`GET /data_maps/{data_map_id}`

## Request

- Base URL: `https://dataops.nexla.io/nexla-api`
- URL: `https://dataops.nexla.io/nexla-api/data_maps/{data_map_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/nexla/apis/nexla-rest-api/docs/data_maps/:data_map_id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves a data map object if a valid ID is provided.

This call to `/data_maps` **does not** return data map entries, as they can be a large array of objects for big data maps. 

You can include the `expand` query parameter to fetch the data map entries of smaller static data maps.

## Path parameters

- `data_map_id` integer, required

## Query parameters

- `expand` 1: Add this parameter to a resource fetch request to receive details about related resources in the response.

## Headers

- `Accept` 'application/vnd.nexla.api.v1+json' | 'application/json': Setting to `application/vnd.nexla.api.v1+json` is recommended.

## Response `200`

Success

- DataMap
  - `id` integer
  - `name` string
  - `description` string
  - `public` boolean
  - `managed` boolean
  - `data_type` string
  - `data_format` string, nullable
  - `data_sink_id` string, nullable
  - `emit_data_default` boolean
  - `use_versioning` boolean
  - `map_primary_key` string
  - `data_defaults` object
  - `updated_at` string, date-time
  - `created_at` string, date-time
  - `owner` object
    - `id` integer
    - `full_name` string
    - `email` string, email
  - `org` OrgSimplified
    - `id` integer
    - `name` string
    - `email_domain` string
    - `email` string
    - `client_identifier` string
    - `org_webhook_host` string
  - `access_roles` string[]: This property reflects all the permissions the user/team/organization has to this resource. 1. `collaborator`: The user/team/organization can view the resource but not make any modifications to it. 2. `operator`: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it. 3. `administrator`: The user/team/organization has complete administrative rights to this resource. 4. `owner`: This user created the resource and so has complete administrative rights to it.
  - `data_set_id` integer
  - `map_entry_count` integer
  - `map_entry_schema` object
  - `tags` string[]

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

---

[API](https://skmtc.dev/nexla/apis/nexla-rest-api.md) - [All operations](https://skmtc.dev/nexla/apis/nexla-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nexla/apis/nexla-rest-api/revisions/ef02be92fe7b?raw)