V2 Teamspaces

List teamspace folders (v2)

get

Returns teamspace folders with the resources currently published into each folder. Use this before publishing or unpublishing to choose the right destination.

Responses

200

Teamspace folders retrieved successfully

application/json

idstring · uuidOptional

orderinteger · int32Optional

namestringOptional

401

Unauthorized

application/json

get

/api/v2/teamspaces/folders

HTTPcURLJavaScriptPython

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

[
  {
    "id": "f45a251d-3ea0-4b41-bfe8-c0f44c8ad54a",
    "order": 1,
    "name": "Shared Dashboards",
    "resources": [
      {
        "id": "0f6f062f-1478-4df2-96a1-c495d037d260",
        "name": "Executive Revenue",
        "type": "DISPLAY",
        "isInSpace": true,
        "additionalProperties": {}
      }
    ],
    "additionalProperties": {}
  }
]

Create teamspace folder (v2)

post

Creates a folder inside the teamspace publishing area. Use it to group resources that are meant to be shared with other users.

Body

application/json

namestringOptional

orderinteger · int32Optional

Responses

200

Teamspace folder created successfully

application/json

folderIdstring · uuidOptional

namestringOptional

400

Invalid folder payload

application/json

401

Unauthorized

application/json

post

/api/v2/teamspaces/folders

HTTPcURLJavaScriptPython

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

{
  "name": "Customer Success",
  "order": 10,
  "additionalProperties": {
    "icon": "folder-users"
  }
}

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

Delete teamspace folder (v2)

delete

Deletes one teamspace folder. Unpublish or move resources first if you want to preserve the shared structure before removal.

Path parameters

folderIdstring · uuidRequired

Responses

200

Teamspace folder deleted successfully

application/json

folderIdstring · uuidOptional

namestringOptional

401

Unauthorized

application/json

404

Folder not found

application/json

delete

/api/v2/teamspaces/folders/{folderId}

HTTPcURLJavaScriptPython

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

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

Patch teamspace folder (v2)

patch

Updates one teamspace folder. Use this to rename the folder, change its sort order, or replace additionalProperties.

Path parameters

folderIdstring · uuidRequired

Body

application/json

namestringOptional

orderinteger · int32Optional

Responses

200

Teamspace 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/teamspaces/folders/{folderId}

HTTPcURLJavaScriptPython

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

{
  "name": "Shared KPIs",
  "order": 5,
  "additionalProperties": {
    "icon": "chart-bar"
  }
}

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

Publish resource to teamspace (v2)

post

Publishes one resource into the teamspace area. targetFolderId identifies the destination shared folder and resourceName is the label visible to teamspace consumers.

Body

application/json

resourceIdstring · uuidOptional

resourceTypestring · enumOptionalPossible values:

resourceNamestringOptional

targetFolderIdstring · uuidOptional

Responses

200

Resource published successfully

application/json

resourceIdstring · uuidOptional

resourceTypestring · enumOptionalPossible values:

targetFolderIdstring · uuidOptional

publishedbooleanOptional

400

Invalid publish payload

application/json

401

Unauthorized

application/json

404

Folder or resource not found

application/json

post

/api/v2/teamspaces/resources:publish

HTTPcURLJavaScriptPython

POST /api/v2/teamspaces/resources:publish HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 169

{
  "resourceId": "0f6f062f-1478-4df2-96a1-c495d037d260",
  "resourceType": "DISPLAY",
  "resourceName": "Executive Revenue",
  "targetFolderId": "f45a251d-3ea0-4b41-bfe8-c0f44c8ad54a"
}

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

Unpublish resource from teamspace (v2)

post

Removes one resource from the teamspace area. Use this when the resource should no longer be visible in shared folders.

Body

application/json

resourceIdstring · uuidOptional

Responses

200

Resource unpublished successfully

application/json

resourceIdstring · uuidOptional

resourceTypestring · enumOptionalPossible values:

targetFolderIdstring · uuidOptional

publishedbooleanOptional

400

Invalid unpublish payload

application/json

401

Unauthorized

application/json

404

Resource not found

application/json

post

/api/v2/teamspaces/resources:unpublish

HTTPcURLJavaScriptPython

POST /api/v2/teamspaces/resources:unpublish HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "resourceId": "0f6f062f-1478-4df2-96a1-c495d037d260"
}

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