V2 Data

Create record (v2)

post

Creates one record using field slugs instead of field UUIDs. The response includes recordId and revision.

Path parameters

schemaIdstring · uuidRequired

Body

application/json

Responses

201

Record created successfully

application/json

400

Invalid record payload

application/json

401

Unauthorized

application/json

post

/api/v2/schemas/{schemaId}/records

HTTPcURLJavaScriptPython

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

{
  "values": {
    "contact-name": "Ada Lovelace",
    "contact-email": "[email protected]"
  }
}

{
  "recordId": "123e4567-e89b-12d3-a456-426614174000",
  "values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "revision": "text"
}

Get record (v2)

get

Path parameters

schemaIdstring · uuidRequired

recordIdstring · uuidRequired

Responses

200

Record retrieved successfully

application/json

recordIdstring · uuidOptional

revisionstringOptional

401

Unauthorized

application/json

404

Record not found

application/json

get

/api/v2/schemas/{schemaId}/records/{recordId}

HTTPcURLJavaScriptPython

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

{
  "recordId": "123e4567-e89b-12d3-a456-426614174000",
  "values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "revision": "text"
}

Delete record (v2)

delete

Path parameters

schemaIdstring · uuidRequired

recordIdstring · uuidRequired

Query parameters

expectedRevisionstringOptional

Responses

200

Record deleted successfully

application/json

recordIdstring · uuidOptional

deletedbooleanOptional

401

Unauthorized

application/json

404

Record not found

application/json

409

Revision conflict

application/json

delete

/api/v2/schemas/{schemaId}/records/{recordId}

HTTPcURLJavaScriptPython

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

{
  "recordId": "123e4567-e89b-12d3-a456-426614174000",
  "deleted": true
}

Patch record (v2)

patch

Patches one record using set/unset by field slug. expectedRevision is optional but recommended to avoid concurrent overwrites.

Path parameters

schemaIdstring · uuidRequired

recordIdstring · uuidRequired

Body

application/json

unsetstring[]Optional

expectedRevisionstringOptional

Responses

200

Record updated successfully

application/json

recordIdstring · uuidOptional

revisionstringOptional

400

Invalid record patch

application/json

401

Unauthorized

application/json

409

Revision conflict

application/json

patch

/api/v2/schemas/{schemaId}/records/{recordId}

HTTPcURLJavaScriptPython

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

{
  "set": {
    "contact-name": "Ada Lovelace Updated"
  },
  "unset": [
    "contact-email"
  ],
  "expectedRevision": "67da073c6795685da2dcbcff796cfedd5eb5b880dee71da6487896fa230d0267"
}

{
  "recordId": "123e4567-e89b-12d3-a456-426614174000",
  "values": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "revision": "text"
}

Query records (v2)

post

Runs the simple agent-oriented record query contract using field slugs and a simplified where/sort/page shape.

Path parameters

schemaIdstring · uuidRequired

Body

application/json

selectstring[]Optional

Responses

200

Query executed successfully

application/json

400

Invalid query payload

application/json

401

Unauthorized

application/json

post

/api/v2/schemas/{schemaId}/records:query

HTTPcURLJavaScriptPython

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

{
  "select": [
    "id",
    "contact-name"
  ],
  "where": [
    {
      "field": "id",
      "op": "eq",
      "value": "550e8400-e29b-41d4-a716-446655440000"
    }
  ],
  "sort": [
    {
      "field": "id",
      "direction": "DESC"
    }
  ],
  "page": {
    "offset": 0,
    "size": 10
  }
}

{
  "records": [
    {
      "recordId": "123e4567-e89b-12d3-a456-426614174000",
      "values": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "revision": "text"
    }
  ],
  "page": {
    "offset": 1,
    "size": 1,
    "total": 1,
    "returned": 1,
    "hasMore": true
  }
}