Valyourise Logo

ValYouRise

DevelopmentApi

Get workspace list payload

Returns the list-view payload for a workspace, including viewer context and visible OKR items.

GET
/api/workspaces/{workspaceId}/list

Returns the list-view payload for a workspace, including viewer context and visible OKR items.

PAT<token>

Personal Access Token

In: header

Path Parameters

workspaceId*string

Response Body

application/json

curl -X GET "https://loading/api/workspaces/string/list"
{
  "workspace": {
    "$id": "string",
    "organizationId": "string",
    "name": "string",
    "slug": "string",
    "privacyMode": "option_1",
    "createdByUserId": "string",
    "archivedAt": "string"
  },
  "viewer": {
    "userId": "string",
    "role": "workspace_admin",
    "isWorkspaceAdmin": true,
    "privacyMode": "option_1"
  },
  "items": [
    {
      "$id": "string",
      "$sequence": 0,
      "$updatedAt": "string",
      "organizationId": "string",
      "workspaceId": "string",
      "type": "objective",
      "title": "string",
      "description": "string",
      "ownerUserId": "string",
      "assigneeUserIds": [
        "string"
      ],
      "parentId": "string",
      "dueDate": "string",
      "actionStatus": "pending",
      "storyPoints": "0",
      "progressComputed": 100,
      "sortOrder": 0,
      "positionX": 0,
      "positionY": 0,
      "visibility": "full",
      "deletedAt": "string",
      "deletedByUserId": "string"
    }
  ]
}
Empty