---
title: "GET /sources/{sourceId}"
method: GET
path: "/sources/{sourceId}"
tags: ["source"]
---

# GET /sources/{sourceId}

`GET /sources/{sourceId}`

## Request

- Base URL: `https://headless.dataddo.com/customer-api/v1`
- URL: `https://headless.dataddo.com/customer-api/v1/sources/{sourceId}`
- Auth: none declared

Get source detail

## Path parameters

- `sourceId` string, required

## Response `200`

Get source detail

- SourceDTOResource
  - `source` Source
    - `descriptors` Descriptor[]
      - `key` 'EMPTY' | 'DATABASE' | 'TABLE' | 'FILE' | 'FORMAT' | 'PATH' | 'WRITE_MODE' | 'SPREADSHEET_ID' | 'SPREADSHEET' | 'SHEET' | 'DATASET' | 'PROJECT' | 'SCHEMA' | 'TOPIC' | 'ACCOUNT' | 'TYPE' | 'REPORT' | 'GRANULARITY' | 'CHANNEL' | 'PROPERTY' | 'BUCKET'
      - `value` string: descriptor value
    - `external_id` string, nullable: The id of the document in external systems. By setting external_id you can link document with external systems id.
    - `is_locked` boolean: You may mark the document as locked to prevent accidental changes. When locked, the document cannot be modified or deleted.
    - `label` string
    - `description` string
    - `type` string
    - `customer_id` string
    - `created_at` integer
    - `updated_at` integer
  - `storage` StorageSourceMeta
    - `id` string
    - `engine` SourceEngineResource
      - `name` string
      - `region` 'ap-northeast-2' | 'ap-southeast-2' | 'ca-central-1' | 'eu-west-1' | 'sa-east-1' | 'us-west-2' | 'europe-west1' | 'europe-west9' | 'us-west1' | 'vig-prg' | 'poc-ts' | 'poc-alza'
    - `metadata` object: Various source metadata in form of key-value pairs. The key is the metadata name and the value is the metadata value. Changing the metadata values may influence the source data extraction processing and is not recommended.
    - `columns` SourceColumnResource[]
      - `column_id` string
      - `label` string
      - `origin_key` string
      - `request_key` string
      - `type` 'string' | 'date' | 'integer' | 'float' | 'boolean' | 'json' | 'timestamp_ms' | 'decimal' | 'timestamp_tz'
      - `position` integer
      - `nullable` boolean
      - `sensitive` boolean
    - `row_count` integer
    - `byte_size` integer
    - `revision` integer
  - `engine` SourceEngineResource
    - `name` string
    - `region` 'ap-northeast-2' | 'ap-southeast-2' | 'ca-central-1' | 'eu-west-1' | 'sa-east-1' | 'us-west-2' | 'europe-west1' | 'europe-west9' | 'us-west1' | 'vig-prg' | 'poc-ts' | 'poc-alza'
  - `column` SourceColumnResource[]
    - `column_id` string
    - `label` string
    - `origin_key` string
    - `request_key` string
    - `type` 'string' | 'date' | 'integer' | 'float' | 'boolean' | 'json' | 'timestamp_ms' | 'decimal' | 'timestamp_tz'
    - `position` integer
    - `nullable` boolean
    - `sensitive` boolean
  - `columns` SourceColumnResource[]
    - `column_id` string
    - `label` string
    - `origin_key` string
    - `request_key` string
    - `type` 'string' | 'date' | 'integer' | 'float' | 'boolean' | 'json' | 'timestamp_ms' | 'decimal' | 'timestamp_tz'
    - `position` integer
    - `nullable` boolean
    - `sensitive` boolean
  - `id` string
  - `future_id` string
  - `legacy_id` string
  - `customer_id` string
  - `label` string
  - `description` string
  - `type` string
  - `created` integer: Timestamp
  - `created_at` integer: Timestamp
  - `template_id` string
  - `connector_id` string
  - `row_count` integer
  - `byte_size` integer
  - `engine_region` 'ap-northeast-2' | 'ap-southeast-2' | 'ca-central-1' | 'eu-west-1' | 'sa-east-1' | 'us-west-2' | 'europe-west1' | 'europe-west9' | 'us-west1' | 'vig-prg' | 'poc-ts' | 'poc-alza'

---

[API](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api.md) · [All operations](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api/revisions/dcfa2345bd10?raw)