> ## Documentation Index
> Fetch the complete documentation index at: https://docs.getmetal.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Data Entity

> This endpoint retrieves a Data Entity by its ID

### Auth Headers

<ParamField required header="x-metal-api-key" type="string">
  An API key for your org.
</ParamField>

<ParamField required header="x-metal-client-id" type="string">
  A Client ID for your org.
</ParamField>

### Params

<ParamField required path="id" type="string">
  The unique identifier of the data entity you wish to retrieve.
</ParamField>

### Response

<ResponseField name="data" type="Data Entity Object">
  <Expandable title="properties">
    <ResponseField name="id" type="string">
      The unique identifier of the data entity.
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the data entity.
    </ResponseField>

    <ResponseField name="attributes" type="array">
      An array of attributes, each with a name, type, and value.
    </ResponseField>

    <ResponseField name="createdBy" type="string">
      The user ID who created this entity.
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      Timestamp indicating when the data entity was created.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash theme={null}
  # Example Request
  curl -X GET "https://api.getmetal.io/v1/data-entities/{id}" \
  --header 'Content-Type: application/json' \
  --header 'x-metal-api-key: <api-key>' \
  --header 'x-metal-client-id: <client-id>' \
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "data": {
      "id": "entityID",
      "datasource": "datasourceID",
      "name": "record_deal.pdf",
      "extractedMetadata": [
        {
          "name": "band",
          "type": "string",
          "value": "Iron Maiden"
        },
        {
  				"name": "recordLabel",
  				"value": "EMI",
  				"type": "string"
  			},
      ],
      "sourcetype": "file",
  		"status": "EXTRACTED",
      "createdAt": "2023-08-29T12:34:56.789Z",
      "ocrData": {
  			"updatedAt": "1970-01-01T00:00:00Z",
  			"engine": "unstructured",
  			"dataEntity": "",
  			"filetype": "pdf",
  			"filename": "record_deal.pdf",
  			"data": [
  				{
  					"type": "UncategorizedText",
  					"text": "SEP-3-2R1@ B3:11F FROM: T0:17825834718 P.2"
  				},
  				{
  					"type": "Title",
  					"text": "RECORD DEAL AGREEMENT"
  				},
          // ...
        ],
      },
      "metadataFields": [
  			{
  				"name": "Partners",
  				"type": "string",
  				"description": "Who are the partners involved in the deal?"
        },
      ],
      "url": "signed-url-to-file",
      "createdBy": "007"
  }
  }
  ```
</ResponseExample>
