Schemas

Was this helpful?

Deprecated

Get Schema

get

Warning: This endpoint is deprecated. Please use the List Resources endpoint instead with filter={"operator":"exact","field":"id","value":"your-schema-id"}.

Authorizations

Path parameters

schema_idstringRequired

The ID of the schema to retrieve or update.

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

schema_idstringRequired

ID of the schema to retrieve

Example: d935a76c-2125-4c30-9389-ef42fa7e23bb

Responses

application/json

objectOptional

get

GET /database/schemas/{schema_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

{
  "id": "text",
  "created_at": "2025-04-19T02:02:18.059Z",
  "updated_at": "2025-04-19T02:02:18.059Z",
  "entity_type": "text",
  "native_type": "text",
  "icon": "text",
  "title": "text",
  "title_full": "text",
  "title_cased": "text",
  "description": "text",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    {}
  ],
  "multiplayer_last_modified_by": "text",
  "multiplayer_last_modified": "text",
  "owners": [
    "text"
  ],
  "owners_groups": [
    "text"
  ],
  "collections": [
    "text"
  ],
  "tags": [
    "text"
  ],
  "workspace_id": "text",
  "published": true,
  "archived": true,
  "archived_at": "text",
  "pii": true,
  "verified": true,
  "url": "text",
  "parent": "text",
  "children_count": 1,
  "bookmarked_by": [
    "text"
  ],
  "integration": "text",
  "external_updated_at": "text",
  "internal_usage": 1,
  "internal_users": [
    "text"
  ],
  "external_users": [
    "text"
  ],
  "external_usage": 1,
  "databuilder_id": "text",
  "search_metadata": {},
  "sources": [
    "text"
  ],
  "subscribers": [
    "text"
  ],
  "teams": [
    "text"
  ],
  "stale": true,
  "stale_at": "text",
  "forced_unstale_by_user": true,
  "current_user_permissions": "text",
  "row_count": 1,
  "byte_size": 1,
  "display_metadata": {},
  "question_status": "text",
  "question_priority": "text",
  "question_answered_by": "text",
  "question_assigned_to": "text"
}

Deprecated

List Schemas

get

Warning: This endpoint is deprecated. Please use the List Resources endpoint instead with filter={"operator":"exact","field":"type","value":"schema"}.

Authorizations

Query parameters

integration_idstringOptional

Integration ID

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

parent_idstringOptional

ID of the database

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

titlestringOptional

Title of the schema

Example: Sample Schema

Responses

application/json

all ofOptional

get

GET /database/schemas HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Accept: */*

{
  "links": {
    "next": "https://api.secoda.co/resource/all/?page=2",
    "previous": "None"
  },
  "meta": {
    "page": 1,
    "previous_page": "None",
    "next_page": 2
  },
  "count": 315,
  "total_pages": 7,
  "results": [
    {
      "id": "text",
      "created_at": "2025-04-19T02:02:18.059Z",
      "updated_at": "2025-04-19T02:02:18.059Z",
      "entity_type": "text",
      "native_type": "text",
      "icon": "text",
      "title": "text",
      "title_full": "text",
      "title_cased": "text",
      "description": "text",
      "definition": "text",
      "definition_version": 1,
      "multiplayers": [
        {}
      ],
      "multiplayer_last_modified_by": "text",
      "multiplayer_last_modified": "text",
      "owners": [
        "text"
      ],
      "owners_groups": [
        "text"
      ],
      "collections": [
        "text"
      ],
      "tags": [
        "text"
      ],
      "workspace_id": "text",
      "published": true,
      "archived": true,
      "archived_at": "text",
      "pii": true,
      "verified": true,
      "url": "text",
      "parent": "text",
      "children_count": 1,
      "bookmarked_by": [
        "text"
      ],
      "integration": "text",
      "external_updated_at": "text",
      "internal_usage": 1,
      "internal_users": [
        "text"
      ],
      "external_users": [
        "text"
      ],
      "external_usage": 1,
      "databuilder_id": "text",
      "search_metadata": {},
      "sources": [
        "text"
      ],
      "subscribers": [
        "text"
      ],
      "teams": [
        "text"
      ],
      "stale": true,
      "stale_at": "text",
      "forced_unstale_by_user": true,
      "current_user_permissions": "text",
      "row_count": 1,
      "byte_size": 1,
      "display_metadata": {},
      "question_status": "text",
      "question_priority": "text",
      "question_answered_by": "text",
      "question_assigned_to": "text"
    }
  ]
}

Create Schema

post

Create a new schema. Schema must have one database as a parent, and be associated with an integration.

Authorizations

Body

native_typestringOptional

The native type of the schema as it's referred to in the integration.

Example: System

databasestringOptional

The title of the database.

Example: Sample Database

Responses

application/json

objectOptional

post

POST /database/schemas HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 821

{
  "native_type": "System",
  "database": "Sample Database",
  "title": "Sample Title",
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "description": "This is a description for a sample table.",
  "entity_type": "glossary",
  "definition": "\\n# Castae illa\\n\\n## Finemque aequore\\n\\nLorem markdownum motus",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "pii": false,
  "verified": true,
  "published": true,
  "teams": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260",
    "cca810f1-11c1-4117-bc23-20ae8020897f"
  ],
  "owners": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "owners_groups": [
    "f3bdd4f8-d6ea-4f9b-8384-e179fa8eb3da"
  ],
  "collections": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "tags": [
    "04654d61-4f64-4f08-b697-3915b5137c49",
    "429693a2-a5e7-4525-b413-ece5e96bc5b3"
  ],
  "subscribers": [
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ]
}

{
  "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
  "created_at": "2023-08-16T23:12:53.245493Z",
  "updated_at": "2023-08-16T23:12:53.245507Z",
  "entity_type": "table",
  "native_type": "Dataset",
  "bookmarked_by": [
    "d935a76c-2125-4c30-9389-ef42fa7e23bb",
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "icon": "icon-url.png",
  "title": "Sample Table",
  "title_full": "Sample Database.Sample Schema.Sample Table",
  "title_cased": "sampleTable",
  "description": "This is a description for a sample table.",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
  "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
  "owners": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "owners_groups": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "collections": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
  ],
  "tags": [
    "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
    "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
  ],
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "total_usage": 483,
  "published": false,
  "archived": false,
  "pii": true,
  "verified": false,
  "url": "https://example.com/sample-table",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "children_count": 2,
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "external_updated_at": "2023-08-16T23:12:53.245507Z",
  "internal_usage": 3,
  "internal_users": [
    "04654d61-4f64-4f08-b697-3915b5137c49"
  ],
  "external_users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ],
  "external_usage": 38,
  "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
  "search_metadata": {
    "cluster": "glue",
    "database": "awsdatacatalog",
    "schema": "secoda-glue",
    "type": "table"
  },
  "sources": [
    "8a3af948-026c-45d6-983d-3873f6156f86"
  ],
  "subscribers": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "teams": [
    "8680f886-97d2-4f4e-92c8-c80b46a3017d"
  ],
  "stale": false,
  "current_user_permissions": {
    "read": true,
    "write": true,
    "execute": false
  }
}

Update Schema

patch

Use this endpoint to update schema metadata.

Authorizations

Path parameters

schema_idstringRequired

The ID of the schema to retrieve or update.

Example: df2c0597-13d9-4159-bb6d-00b3f54235dc

Body

descriptionstringOptional

A description of the resource.

Example: This is a description for a sample table.

definitionstringOptional

Mark down documentation to be added to the resource.

Example: \n# Castae illa\n\n## Finemque aequore\n\nLorem markdownum motus

piibooleanOptional

Indicates whether the resource contains personally identifiable information (PII). Values can be - True False

Example: false

verifiedbooleanOptional

Indicates whether the table has been set as verified. Values can be - True False

Example: true

publishedbooleanOptional

Indicates if the resource is visible to viewers or not. Values can be - True False

Example: true

teamsstring[]Optional

A list of team IDs that the resource belongs to.

Example: ["e8ac09ed-e51e-4e61-8eaf-59942c98c260","cca810f1-11c1-4117-bc23-20ae8020897f"]

ownersstring[]Optional

A list of owner user IDs for the resource.

Example: ["33733f42-8ff7-460b-9e20-50a2133d3bb0","c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

collectionsstring[]Optional

A list of collection IDs the resource belongs to.

Example: ["3b2c7185-fb5d-4d94-89d4-3dae08e093a9"]

tagsstring[]Optional

A list of tag IDs associated with the resources.

Example: ["04654d61-4f64-4f08-b697-3915b5137c49","429693a2-a5e7-4525-b413-ece5e96bc5b3"]

subscribersstring[]Optional

A list of the added user IDs that have been subscribed to the resource. Anyone subscribed will be notified of any changes.

Example: ["c90dedee-40ee-47ec-9c27-96dc3b2ec363"]

Responses

application/json

objectOptional

patch

PATCH /database/schemas/{schema_id} HTTP/1.1
Host: api.secoda.co
Authorization: Bearer string
Content-Type: application/json
Accept: */*
Content-Length: 563

{
  "description": "This is a description for a sample table.",
  "definition": "\\n# Castae illa\\n\\n## Finemque aequore\\n\\nLorem markdownum motus",
  "pii": false,
  "verified": true,
  "published": true,
  "teams": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260",
    "cca810f1-11c1-4117-bc23-20ae8020897f"
  ],
  "owners": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "collections": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "tags": [
    "04654d61-4f64-4f08-b697-3915b5137c49",
    "429693a2-a5e7-4525-b413-ece5e96bc5b3"
  ],
  "subscribers": [
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ]
}

{
  "id": "d935a76c-2125-4c30-9389-ef42fa7e23bb",
  "created_at": "2023-08-16T23:12:53.245493Z",
  "updated_at": "2023-08-16T23:12:53.245507Z",
  "entity_type": "table",
  "native_type": "Dataset",
  "bookmarked_by": [
    "d935a76c-2125-4c30-9389-ef42fa7e23bb",
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "icon": "icon-url.png",
  "title": "Sample Table",
  "title_full": "Sample Database.Sample Schema.Sample Table",
  "title_cased": "sampleTable",
  "description": "This is a description for a sample table.",
  "definition": "text",
  "definition_version": 1,
  "multiplayers": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "multiplayer_last_modified_by": "429693a2-a5e7-4525-b413-ece5e96bc5b3",
  "multiplayer_last_modified": "2023-08-16T23:12:53.245507Z",
  "owners": [
    "429693a2-a5e7-4525-b413-ece5e96bc5b3",
    "f71585fa-251c-4102-8d81-c97c57c8d435"
  ],
  "owners_groups": [
    "3b2c7185-fb5d-4d94-89d4-3dae08e093a9"
  ],
  "collections": [
    "e8ac09ed-e51e-4e61-8eaf-59942c98c260"
  ],
  "tags": [
    "f7466f09-33bf-4ac2-9ff2-165fb4b8bdc2",
    "a17f4ed0-0e5a-45a9-92c0-6c93c0b8242c"
  ],
  "workspace_id": "f71585fa-251c-4102-8d81-c97c57c8d435",
  "total_usage": 483,
  "published": false,
  "archived": false,
  "pii": true,
  "verified": false,
  "url": "https://example.com/sample-table",
  "parent": "df2c0597-13d9-4159-bb6d-00b3f54235dc",
  "children_count": 2,
  "integration": "ca529385-fbc9-4934-afae-e372affe795b",
  "external_updated_at": "2023-08-16T23:12:53.245507Z",
  "internal_usage": 3,
  "internal_users": [
    "04654d61-4f64-4f08-b697-3915b5137c49"
  ],
  "external_users": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0"
  ],
  "external_usage": 38,
  "databuilder_id": "b818280a-ae1a-43bf-90d3-dbccf812b025.x68605bd2",
  "search_metadata": {
    "cluster": "glue",
    "database": "awsdatacatalog",
    "schema": "secoda-glue",
    "type": "table"
  },
  "sources": [
    "8a3af948-026c-45d6-983d-3873f6156f86"
  ],
  "subscribers": [
    "33733f42-8ff7-460b-9e20-50a2133d3bb0",
    "c90dedee-40ee-47ec-9c27-96dc3b2ec363"
  ],
  "teams": [
    "8680f886-97d2-4f4e-92c8-c80b46a3017d"
  ],
  "stale": false,
  "current_user_permissions": {
    "read": true,
    "write": true,
    "execute": false
  }
}