GET /WorkApps/{workAppId}

Retrieves details of a specific Work App.

get
Authorizations
Path parameters
workAppIdstring · uuidRequired

The Work App's unique identifier.

Header parameters
X-API-SECRETstringRequired

API Secret is used to verify the integrity of the request and authenticate the client. It should be included in all requests. This value must be kept confidential and should never be exposed in client-side code or public repositories.

Example: YOUR_API_SECRET
Responses
200

OK

get
GET /api/v1/WorkApps/{workAppId} HTTP/1.1
Host: open-api.getcakewalk.io
X-API-KEY: YOUR_API_KEY
X-API-SECRET: YOUR_API_SECRET
Accept: */*
{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "categoryId": 1,
    "categoryName": "CATEGORY_OFFICE_SUITE",
    "numberOfAccounts": 1,
    "isBundle": true,
    "owner": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "email": "text",
      "statusId": 1,
      "statusName": "text"
    },
    "url": "text",
    "imageUrl": "text",
    "statusId": 1,
    "statusName": "Managed",
    "serverLocations": [
      "text"
    ],
    "certifications": [
      "text"
    ],
    "aiRisk": {
      "id": 1,
      "level": "text",
      "reasoning": "text"
    },
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "defaultUsersGroups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ],
    "hiddenUsersGroups": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  },
  "links": {
    "self": "text",
    "next": "text"
  }
}

Last updated

Was this helpful?