V2 Navigation

List navigation folders (v2)

get

Returns the workspace navigation tree as folders with embedded resources. Folders are sorted by order so agents can plan moves without a second lookup.

Responses

200

Navigation folders retrieved successfully

application/json

idstring · uuidOptional

orderinteger · int32Optional

namestringOptional

401

Unauthorized

application/json

get

/api/v2/navigation/folders

HTTPcURLJavaScriptPython

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

[
  {
    "id": "84a0fca4-37ef-4c83-a8ed-9ef67ad9324a",
    "order": 1,
    "name": "Sales",
    "resources": [
      {
        "id": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
        "name": "Contacts",
        "type": "SCHEMA",
        "isInSpace": false,
        "additionalProperties": {}
      }
    ],
    "additionalProperties": {
      "color": "blue"
    }
  }
]

Create navigation folder (v2)

post

Creates a navigation folder for organizing resources inside the workspace. additionalProperties can store client metadata without changing routing behavior.

Body

application/json

namestringOptional

orderinteger · int32Optional

Responses

200

Navigation folder created successfully

application/json

folderIdstring · uuidOptional

namestringOptional

400

Invalid folder payload

application/json

401

Unauthorized

application/json

post

/api/v2/navigation/folders

HTTPcURLJavaScriptPython

POST /api/v2/navigation/folders HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "name": "Finance",
  "order": 20,
  "additionalProperties": {
    "color": "green"
  }
}

{
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

Delete navigation folder (v2)

delete

Deletes one navigation folder. Move any resources you still need before calling this endpoint because the folder itself is removed.

Path parameters

folderIdstring · uuidRequired

Responses

200

Navigation folder deleted successfully

application/json

folderIdstring · uuidOptional

namestringOptional

401

Unauthorized

application/json

404

Folder not found

application/json

delete

/api/v2/navigation/folders/{folderId}

HTTPcURLJavaScriptPython

DELETE /api/v2/navigation/folders/{folderId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

{
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

Patch navigation folder (v2)

patch

Updates one navigation folder. Use this to rename the folder, adjust its display order, or replace additionalProperties.

Path parameters

folderIdstring · uuidRequired

Body

application/json

namestringOptional

orderinteger · int32Optional

Responses

200

Navigation folder updated successfully

application/json

folderIdstring · uuidOptional

namestringOptional

400

Invalid folder payload

application/json

401

Unauthorized

application/json

404

Folder not found

application/json

patch

/api/v2/navigation/folders/{folderId}

HTTPcURLJavaScriptPython

PATCH /api/v2/navigation/folders/{folderId} HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "name": "Finance Ops",
  "order": 30,
  "additionalProperties": {
    "color": "teal"
  }
}

{
  "folderId": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text"
}

Move navigation resource (v2)

post

Moves one resource into a navigation folder. resourceType disambiguates what is being moved, and targetFolderId identifies the destination folder.

Body

application/json

resourceIdstring · uuidOptional

resourceTypestring · enumOptionalPossible values:

targetFolderIdstring · uuidOptional

Responses

200

Resource moved successfully

application/json

resourceIdstring · uuidOptional

resourceTypestring · enumOptionalPossible values:

targetFolderIdstring · uuidOptional

400

Invalid move payload

application/json

401

Unauthorized

application/json

404

Folder or resource not found

application/json

post

/api/v2/navigation/resources:move

HTTPcURLJavaScriptPython

POST /api/v2/navigation/resources:move HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "resourceId": "2eb8bdcf-6d9c-4fbb-9018-7fa8180f4c5e",
  "resourceType": "SCHEMA",
  "targetFolderId": "84a0fca4-37ef-4c83-a8ed-9ef67ad9324a"
}

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