GET
/
api
/
code
/
v1
/
{id}
curl --request GET \
  --url https://developer.synq.io/api/code/v1/{id} \
  --header 'Authorization: Bearer <token>'
{
  "codes": [
    {
      "definerIdentifier": {
        "dbtCoreNode": {
          "integrationId": "<string>",
          "nodeId": "<string>"
        },
        "dbtCloudNode": {
          "projectId": "<string>",
          "accountId": "<string>",
          "nodeId": "<string>"
        },
        "bigqueryTable": {
          "project": "<string>",
          "dataset": "<string>",
          "table": "<string>"
        },
        "snowflakeTable": {
          "account": "<string>",
          "database": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "redshiftTable": {
          "cluster": "<string>",
          "database": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "postgresTable": {
          "host": "<string>",
          "database": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "mysqlTable": {
          "host": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "clickhouseTable": {
          "host": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        },
        "airflowTask": {
          "integrationId": "<string>",
          "dagId": "<string>",
          "taskId": "<string>"
        },
        "custom": {
          "id": "<string>"
        },
        "dataproduct": {
          "id": "<string>"
        },
        "synqPath": {
          "path": "<string>"
        },
        "databricksTable": {
          "workspace": "<string>",
          "catalog": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "trinoTable": {
          "host": "<string>",
          "catalog": "<string>",
          "schema": "<string>",
          "table": "<string>"
        },
        "sqlMeshModel": {
          "integrationId": "<string>",
          "fqn": "<string>"
        },
        "sqlMeshAudit": {
          "integrationId": "<string>",
          "fqn": "<string>",
          "auditId": "<string>"
        },
        "monitor": {
          "monitoredId": {},
          "monitorId": "<string>",
          "segment": "<string>",
          "integrationId": "<string>"
        }
      },
      "definerSynqPath": "<string>",
      "stateAt": "2023-11-07T05:31:56Z",
      "codeType": 123,
      "sqlDialect": 123,
      "content": "<string>",
      "codeName": "<string>",
      "filePath": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
object
required

Identifier of the entity to retrieve code for. This can be any entity type that contains code artifacts.

Response

200
application/json

OK

ListCodeResponse is the response message for the ListCode method.