Database

List database folders

get

Responses

200

Database folders retrieved successfully

application/json

idstring · uuidOptional

orderinteger · int32Optional

namestringOptional

401

Unauthorized - Invalid or missing JWT token

application/json

get

/api/database/

HTTPcURLJavaScriptPython

GET /api/database/ HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "order": 1,
    "name": "text",
    "resources": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "type": "SCHEMA",
        "isInSpace": true,
        "additionalProperties": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    ],
    "additionalProperties": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

Retrieve all schemas

get

Returns a list of all available schemas in the current workspace. Each schema defines the structure of a data collection, including its fields, validation rules, and display configurations. Use this endpoint to discover available data structures before querying or inserting data.

Responses

200

List of schemas retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

highlightFieldIdstring · uuidOptional

401

Unauthorized - Invalid or missing JWT token

application/json

get

/api/schema/

HTTPcURLJavaScriptPython

GET /api/schema/ HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Customers",
    "slug": "customers",
    "auditable": true,
    "commentable": true,
    "fields": [
      {
        "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
        "fieldType": "TextField",
        "headerName": "Name",
        "slug": "name",
        "required": true,
        "unique": false
      },
      {
        "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "fieldType": "TextField",
        "headerName": "Email",
        "slug": "email",
        "required": true,
        "unique": true
      }
    ],
    "viewsConfig": []
  }
]

Retrieve a schema by ID

get

Fetches a specific schema by its unique identifier. Returns the complete schema definition including all fields with their types, validation rules, and additional properties. Use this endpoint to get detailed information about a specific data structure before performing operations on its records.

Path parameters

schemaIdstring · uuidRequired

Unique identifier (UUID) of the schema to retrieve

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Schema retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

highlightFieldIdstring · uuidOptional

400

Invalid schema ID format - The provided ID is not a valid UUID

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

Schema not found - No schema exists with the provided ID

application/json

get

/api/schema/{schemaId}

HTTPcURLJavaScriptPython

GET /api/schema/{schemaId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Products",
  "slug": "products",
  "auditable": true,
  "commentable": false,
  "fields": [
    {
      "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "fieldType": "TextField",
      "headerName": "Product Name",
      "slug": "product-name",
      "required": true,
      "unique": false
    },
    {
      "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "fieldType": "NumberField",
      "headerName": "Price",
      "slug": "price",
      "required": true,
      "unique": false
    },
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "fieldType": "OptionField",
      "headerName": "Category",
      "slug": "category",
      "required": false,
      "unique": false
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "fieldType": "ReferenceField",
      "headerName": "Supplier",
      "slug": "supplier",
      "required": false,
      "unique": false
    }
  ],
  "viewsConfig": [
    {
      "id": "default-view",
      "name": "Default View",
      "type": "grid",
      "default": true,
      "erasable": false
    }
  ]
}

Create database folder

post

Body

application/json

folderIdstring · uuidOptional

namestringOptional

orderinteger · int32Optional

Responses

200

OK

*/*

anyOptional

post

/api/database/group/add

HTTPcURLJavaScriptPython

POST /api/database/group/add HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "order": 1,
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

200

OK

No content

Delete database folder

delete

Responses

200

OK

*/*

anyOptional

delete

/api/database/group/delete/{groupId}

HTTPcURLJavaScriptPython

DELETE /api/database/group/delete/{groupId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

200

OK

No content

Update database folder

put

Body

application/json

folderIdstring · uuidOptional

namestringOptional

orderinteger · int32Optional

Responses

200

OK

*/*

anyOptional

put

/api/database/group/update

HTTPcURLJavaScriptPython

PUT /api/database/group/update HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "order": 1,
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

200

OK

No content

Move resource in database folders

put

Body

application/json

resourceIdstring · uuidOptional

resourceTypestring · enumOptionalPossible values:

targetFolderIdstring · uuidOptional

Responses

200

OK

*/*

anyOptional

put

/api/database/resource/move

HTTPcURLJavaScriptPython

PUT /api/database/resource/move HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "resourceId": "123e4567-e89b-12d3-a456-426614174000",
  "resourceType": "SCHEMA",
  "targetFolderId": "123e4567-e89b-12d3-a456-426614174000"
}

200

OK

No content

Create a schema

post

Creates a new schema definition for the current workspace.

Body

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

highlightFieldIdstring · uuidOptional

Responses

200

Schema created successfully

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

highlightFieldIdstring · uuidOptional

400

Invalid schema payload

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

post

/api/schema/add

HTTPcURLJavaScriptPython

POST /api/schema/add HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 1443

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fieldType": "text",
      "headerName": "text",
      "slug": "text",
      "required": true,
      "unique": true,
      "system": true,
      "additionalProperties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "segmentedByFieldId": "text"
    }
  ],
  "auditable": true,
  "commentable": true,
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "viewsConfig": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "default": true,
      "erasable": true,
      "fields": [
        "text"
      ],
      "filters": null,
      "order": null,
      "columnSize": null,
      "groupsExpanded": null,
      "additionalProperties": null,
      "hierarchyConfig": {
        "columns": {
          "label": "text",
          "infos": [
            {
              "id": "text",
              "name": "text"
            }
          ],
          "numbers": [
            {
              "id": "text",
              "name": "text",
              "aggregation": "COUNT"
            }
          ]
        },
        "rootLevel": {
          "name": "text",
          "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
          "infoMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "numberMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        },
        "childLevels": [
          {
            "name": "text",
            "schemaId": "123e4567-e89b-12d3-a456-426614174000",
            "childFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "infoMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "numberMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          }
        ]
      }
    }
  ],
  "highlightFieldId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fieldType": "text",
      "headerName": "text",
      "slug": "text",
      "required": true,
      "unique": true,
      "system": true,
      "additionalProperties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "segmentedByFieldId": "text"
    }
  ],
  "auditable": true,
  "commentable": true,
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "viewsConfig": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "default": true,
      "erasable": true,
      "fields": [
        "text"
      ],
      "filters": null,
      "order": null,
      "columnSize": null,
      "groupsExpanded": null,
      "additionalProperties": null,
      "hierarchyConfig": {
        "columns": {
          "label": "text",
          "infos": [
            {
              "id": "text",
              "name": "text"
            }
          ],
          "numbers": [
            {
              "id": "text",
              "name": "text",
              "aggregation": "COUNT"
            }
          ]
        },
        "rootLevel": {
          "name": "text",
          "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
          "infoMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "numberMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        },
        "childLevels": [
          {
            "name": "text",
            "schemaId": "123e4567-e89b-12d3-a456-426614174000",
            "childFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "infoMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "numberMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          }
        ]
      }
    }
  ],
  "highlightFieldId": "123e4567-e89b-12d3-a456-426614174000"
}

Delete a schema

delete

Deletes a schema by its unique identifier.

Path parameters

schemaIdstring · uuidRequired

Unique identifier (UUID) of the schema to delete

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Schema deleted successfully

application/json

anyOptional

400

Invalid schema ID format - The provided ID is not a valid UUID

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

Schema not found - No schema exists with the provided ID

application/json

delete

/api/schema/delete/{schemaId}

HTTPcURLJavaScriptPython

DELETE /api/schema/delete/{schemaId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

No content

Update a schema

put

Updates an existing schema definition in the current workspace.

Body

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

highlightFieldIdstring · uuidOptional

Responses

200

Schema updated successfully

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

highlightFieldIdstring · uuidOptional

400

Invalid schema payload

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

404

Schema not found - No schema exists with the provided ID

application/json

put

/api/schema/update

HTTPcURLJavaScriptPython

PUT /api/schema/update HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 1443

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fieldType": "text",
      "headerName": "text",
      "slug": "text",
      "required": true,
      "unique": true,
      "system": true,
      "additionalProperties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "segmentedByFieldId": "text"
    }
  ],
  "auditable": true,
  "commentable": true,
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "viewsConfig": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "default": true,
      "erasable": true,
      "fields": [
        "text"
      ],
      "filters": null,
      "order": null,
      "columnSize": null,
      "groupsExpanded": null,
      "additionalProperties": null,
      "hierarchyConfig": {
        "columns": {
          "label": "text",
          "infos": [
            {
              "id": "text",
              "name": "text"
            }
          ],
          "numbers": [
            {
              "id": "text",
              "name": "text",
              "aggregation": "COUNT"
            }
          ]
        },
        "rootLevel": {
          "name": "text",
          "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
          "infoMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "numberMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        },
        "childLevels": [
          {
            "name": "text",
            "schemaId": "123e4567-e89b-12d3-a456-426614174000",
            "childFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "infoMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "numberMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          }
        ]
      }
    }
  ],
  "highlightFieldId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "text",
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "fieldType": "text",
      "headerName": "text",
      "slug": "text",
      "required": true,
      "unique": true,
      "system": true,
      "additionalProperties": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "segmentedByFieldId": "text"
    }
  ],
  "auditable": true,
  "commentable": true,
  "additionalProperties": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "viewsConfig": [
    {
      "id": "text",
      "name": "text",
      "type": "text",
      "default": true,
      "erasable": true,
      "fields": [
        "text"
      ],
      "filters": null,
      "order": null,
      "columnSize": null,
      "groupsExpanded": null,
      "additionalProperties": null,
      "hierarchyConfig": {
        "columns": {
          "label": "text",
          "infos": [
            {
              "id": "text",
              "name": "text"
            }
          ],
          "numbers": [
            {
              "id": "text",
              "name": "text",
              "aggregation": "COUNT"
            }
          ]
        },
        "rootLevel": {
          "name": "text",
          "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
          "infoMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "numberMappings": [
            {
              "columnId": "text",
              "fieldId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        },
        "childLevels": [
          {
            "name": "text",
            "schemaId": "123e4567-e89b-12d3-a456-426614174000",
            "childFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "labelFieldId": "123e4567-e89b-12d3-a456-426614174000",
            "infoMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "numberMappings": [
              {
                "columnId": "text",
                "fieldId": "123e4567-e89b-12d3-a456-426614174000"
              }
            ]
          }
        ]
      }
    }
  ],
  "highlightFieldId": "123e4567-e89b-12d3-a456-426614174000"
}