ListEntities

List all entities.

GET /api/entities/custom/v1/entities

ListEntities

cURL

curl --request GET \
  --url https://developer.synq.io/api/entities/custom/v1/entities \
  --header 'Authorization: Bearer <token>'

200

{
  "entities": [
    {
      "id": {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      },
      "name": "<string>",
      "workspace": "<string>",
      "typeId": 500,
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "synqPath": "<string>",
      "synqCatalogUrl": "<string>",
      "ids": [
        {
          "airflowDag": {
            "integrationId": "<string>",
            "dagId": "<string>"
          }
        }
      ],
      "synqPaths": [
        "<string>"
      ],
      "annotations": [
        {
          "name": "<string>",
          "values": [
            "<string>"
          ]
        }
      ],
      "isDwhTable": true,
      "isDwhView": true
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Response

200 - application/json

Success

entities · Entity · object[]

Show child attributes