V2 Schemas

List schemas (v2)

get

Returns a compact schema list optimized for agents. Each item includes id, slug, and revision.

Responses

200

Schema list retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

fieldCountinteger · int32Optional

revisionstringOptional

401

Unauthorized

application/json

get

/api/v2/schemas

HTTPcURLJavaScriptPython

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

[
  {
    "id": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
    "name": "Contacts",
    "slug": "contacts",
    "auditable": false,
    "commentable": false,
    "fieldCount": 11,
    "revision": "360b0af1fd0ec3c1a0e311b782ea05a43c1495f569693b05c27772cc0eda6737"
  }
]

Get schema (v2)

get

Returns the full public schema representation including fields and the current revision token.

Path parameters

schemaIdstring · uuidRequired

Responses

200

Schema retrieved successfully

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

revisionstringOptional

401

Unauthorized

application/json

404

Schema not found

application/json

get

/api/v2/schemas/{schemaId}

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "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"
              }
            ]
          }
        ]
      }
    }
  ],
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "slug": "text",
      "label": "text",
      "required": true,
      "unique": true,
      "system": true,
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "revision": "text"
}

Patch schema metadata (v2)

patch

Updates only top-level schema metadata. Use expectedRevision to prevent overwriting concurrent changes.

Path parameters

schemaIdstring · uuidRequired

Body

application/json

unsetstring[]Optional

expectedRevisionstringOptional

Responses

200

Schema patched successfully

application/json

idstring · uuidOptional

namestringOptional

slugstringOptional

auditablebooleanOptional

commentablebooleanOptional

revisionstringOptional

400

Invalid schema patch

application/json

401

Unauthorized

application/json

409

Revision conflict

application/json

patch

/api/v2/schemas/{schemaId}

HTTPcURLJavaScriptPython

PATCH /api/v2/schemas/{schemaId} HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "set": {
    "commentable": true
  },
  "expectedRevision": "360b0af1fd0ec3c1a0e311b782ea05a43c1495f569693b05c27772cc0eda6737"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "slug": "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"
              }
            ]
          }
        ]
      }
    }
  ],
  "fields": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "type": "text",
      "slug": "text",
      "label": "text",
      "required": true,
      "unique": true,
      "system": true,
      "config": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "revision": "text"
}

Create schema field (v2)

post

Creates a field with a backend-generated fieldId. expectedRevision is optional but recommended.

Path parameters

schemaIdstring · uuidRequired

Body

application/json

typestringOptional

labelstringOptional

slugstringOptional

requiredbooleanOptional

uniquebooleanOptional

clientRefstringOptional

expectedRevisionstringOptional

Responses

200

Field created successfully

application/json

schemaIdstring · uuidOptional

fieldIdstring · uuidOptional

slugstringOptional

revisionstringOptional

clientRefstringOptional

400

Invalid field payload

application/json

401

Unauthorized

application/json

409

Revision conflict

application/json

post

/api/v2/schemas/{schemaId}/fields

HTTPcURLJavaScriptPython

POST /api/v2/schemas/{schemaId}/fields HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 252

{
  "type": "TextField",
  "slug": "customer_name",
  "label": "Customer Name",
  "required": true,
  "unique": false,
  "config": {
    "defaultValue": ""
  },
  "clientRef": "step-7-create-name-field",
  "expectedRevision": "360b0af1fd0ec3c1a0e311b782ea05a43c1495f569693b05c27772cc0eda6737"
}

{
  "schemaId": "123e4567-e89b-12d3-a456-426614174000",
  "fieldId": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "revision": "text",
  "clientRef": "text"
}

Get schema field (v2)

get

Path parameters

schemaIdstring · uuidRequired

fieldIdstring · uuidRequired

Responses

200

Field retrieved successfully

application/json

idstring · uuidOptional

typestringOptional

slugstringOptional

labelstringOptional

requiredbooleanOptional

uniquebooleanOptional

systembooleanOptional

401

Unauthorized

application/json

404

Field not found

application/json

get

/api/v2/schemas/{schemaId}/fields/{fieldId}

HTTPcURLJavaScriptPython

GET /api/v2/schemas/{schemaId}/fields/{fieldId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "type": "text",
  "slug": "text",
  "label": "text",
  "required": true,
  "unique": true,
  "system": true,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Delete schema field (v2)

delete

Deletes a field. Pass expectedRevision as query parameter when you want optimistic concurrency protection.

Path parameters

schemaIdstring · uuidRequired

fieldIdstring · uuidRequired

Query parameters

expectedRevisionstringOptional

Responses

200

Field deleted successfully

application/json

schemaIdstring · uuidOptional

fieldIdstring · uuidOptional

slugstringOptional

revisionstringOptional

clientRefstringOptional

401

Unauthorized

application/json

404

Field not found

application/json

409

Revision conflict

application/json

delete

/api/v2/schemas/{schemaId}/fields/{fieldId}

HTTPcURLJavaScriptPython

DELETE /api/v2/schemas/{schemaId}/fields/{fieldId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "schemaId": "123e4567-e89b-12d3-a456-426614174000",
  "fieldId": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "revision": "text",
  "clientRef": "text"
}

Patch schema field (v2)

patch

Updates one field with a typed set/unset contract. Use expectedRevision to protect against concurrent edits.

Path parameters

schemaIdstring · uuidRequired

fieldIdstring · uuidRequired

Body

application/json

unsetstring[]Optional

expectedRevisionstringOptional

Responses

200

Field updated successfully

application/json

schemaIdstring · uuidOptional

fieldIdstring · uuidOptional

slugstringOptional

revisionstringOptional

clientRefstringOptional

400

Invalid field patch

application/json

401

Unauthorized

application/json

409

Revision conflict

application/json

patch

/api/v2/schemas/{schemaId}/fields/{fieldId}

HTTPcURLJavaScriptPython

PATCH /api/v2/schemas/{schemaId}/fields/{fieldId} HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 146

{
  "set": {
    "label": "Customer Full Name",
    "required": false,
    "config": {
      "defaultValue": "Unknown"
    }
  },
  "unset": [
    "config.description"
  ],
  "expectedRevision": "13"
}

{
  "schemaId": "123e4567-e89b-12d3-a456-426614174000",
  "fieldId": "123e4567-e89b-12d3-a456-426614174000",
  "slug": "text",
  "revision": "text",
  "clientRef": "text"
}