# GET /WorkApps/{workAppId}

## GET /api/v1/WorkApps/{workAppId}

> Retrieves details of a specific Work App.

```json
{"openapi":"3.0.4","info":{"title":"Cakewalk Open API","version":"v1"},"servers":[{"url":"https://open-api.getcakewalk.io"}],"security":[{"API Key":[]}],"components":{"securitySchemes":{"API Key":{"type":"apiKey","description":"Public API key used to identify the client application. It should be included in all requests.","name":"X-API-KEY","in":"header"}},"schemas":{"WorkAppDetailedRecordViewModelV1":{"required":["data","links"],"type":"object","properties":{"data":{"allOf":[{"$ref":"#/components/schemas/WorkAppDetailedViewModelV1"}],"description":"The single data record returned by the request."},"links":{"allOf":[{"$ref":"#/components/schemas/LinksViewModel"}],"description":"Navigation links related to the resource."}},"additionalProperties":false,"description":"A response model that contains a single data record and related navigation links."},"WorkAppDetailedViewModelV1":{"required":["categoryName","certifications","customFields","defaultUsersGroups","description","hiddenUsersGroups","id","imageUrl","name","serverLocations","statusName","tagLine","url"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the work app.","format":"uuid"},"name":{"minLength":1,"type":"string","description":"Name of the work app."},"categoryId":{"type":"integer","description":"Identifier of the work app's category.","format":"int32"},"categoryName":{"allOf":[{"$ref":"#/components/schemas/WorkAppCategories"}],"description":"Name of the work app's category."},"numberOfAccounts":{"type":"integer","description":"Number users with access to this work app.","format":"int32"},"isBundle":{"type":"boolean","description":"Indicates whether the work app is a bundle."},"owner":{"allOf":[{"$ref":"#/components/schemas/UserSimplifiedViewModelV1"}],"description":"User who owns or manages the work app.","nullable":true},"url":{"minLength":1,"type":"string","description":"URL for accessing the work app."},"imageUrl":{"minLength":1,"type":"string","description":"URL of the image associated with the work app."},"statusId":{"type":"integer","description":"Identifier of the work app's status.","format":"int32"},"statusName":{"allOf":[{"$ref":"#/components/schemas/WorkAppStatus"}],"description":"Name of the work app's status."},"serverLocations":{"type":"array","items":{"type":"string"},"description":"List of geographic server locations where the app operates."},"certifications":{"type":"array","items":{"type":"string"},"description":"List of certifications held by the work app."},"aiRisk":{"allOf":[{"$ref":"#/components/schemas/WorkAppAiRiskLevelViewModelV1"}],"description":"AI risk level information.","nullable":true},"customFields":{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"description":"Custom metadata fields for the work app, structured as nested key-value pairs.","deprecated":true},"defaultUsersGroups":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of user groups where this work app is set as the default."},"hiddenUsersGroups":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of user groups where this work app is hidden from the catalog."},"tagLine":{"minLength":1,"type":"string","description":"Short tagline or summary of the work app."},"description":{"minLength":1,"type":"string","description":"Detailed description of the work app."},"lastActivity":{"type":"string","description":"Date and time of the last user activity in this work app.","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Detailed view of a work app including metadata, configuration, ownership, etc."},"WorkAppCategories":{"enum":["CATEGORY_OFFICE_SUITE","CATEGORY_MESSAGING_AND_COMMUNICATION","CATEGORY_SOFTWARE_DEVELOPMENT","CATEGORY_LEGAL_AND_COMPLIANCE","CATEGORY_SALES","CATEGORY_SECURITY","CATEGORY_PRODUCT_AND_DESIGN","CATEGORY_ANALYTICS","CATEGORY_IT_INFRASTRUCTURE","CATEGORY_COLLABORATION_AND_PRODUCTIVITY","CATEGORY_HR","CATEGORY_FINANCE_AND_ACCOUNTING","CATEGORY_MARKETING","CATEGORY_CONTENT_MANAGEMENT","CATEGORY_COMMERCE","CATEGORY_COMMUNICATION","CATEGORY_CUSTOMER_SERVICE","CATEGORY_TRAVEL","CATEGORY_NEWS_AND_CONTENT","CATEGORY_LEARNING_AND_DEVELOPMENT","CATEGORY_OFFICE_MANAGEMENT","CATEGORY_OPERATIONS_AND_PROCESSES","CATEGORY_ONLINE_SHOPS","CATEGORY_EMPLOYEE_BENEFITS","CATEGORY_LEGAL","CATEGORY_COMPLIANCE","CATEGORY_IT_MANAGEMENT","CATEGORY_OTHER"],"type":"string"},"UserSimplifiedViewModelV1":{"required":["email","id","name","statusName"],"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the user.","format":"uuid"},"name":{"minLength":1,"type":"string","description":"Full name of the user."},"email":{"minLength":1,"type":"string","description":"Email address of the user."},"statusId":{"type":"integer","description":"Identifier of the user's status.","format":"int32"},"statusName":{"minLength":1,"type":"string","description":"Name of the user's status."}},"additionalProperties":false,"description":"Basic user information including identity and status details."},"WorkAppStatus":{"enum":["Managed","Archived","Archiving","Requested","Rejected","Discovered","Restricted","Accepted","Ignored"],"type":"string"},"WorkAppAiRiskLevelViewModelV1":{"required":["level"],"type":"object","properties":{"id":{"type":"integer","description":"Identifier of the AI risk level.","format":"int32"},"level":{"minLength":1,"type":"string","description":"Name of the AI risk level."},"reasoning":{"type":"string","description":"Optional explanation or justification for the assigned risk level.","nullable":true}},"additionalProperties":false,"description":"AI risk level assigned to a work app, including optional reasoning."},"LinksViewModel":{"required":["self"],"type":"object","properties":{"self":{"minLength":1,"type":"string","description":"URL to the current resource or page."},"next":{"type":"string","description":"URL to the next page in the collection, if available.","nullable":true}},"additionalProperties":false,"description":"Pagination-related URLs for navigating a paginated collection."},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}}}},"paths":{"/api/v1/WorkApps/{workAppId}":{"get":{"tags":["WorkApps"],"summary":"Retrieves details of a specific Work App.","parameters":[{"name":"workAppId","in":"path","description":"The Work App's unique identifier.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"X-API-SECRET","in":"header","description":"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.","required":true,"schema":{"type":"string","description":"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."}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/WorkAppDetailedRecordViewModelV1"}},"application/json":{"schema":{"$ref":"#/components/schemas/WorkAppDetailedRecordViewModelV1"}},"text/json":{"schema":{"$ref":"#/components/schemas/WorkAppDetailedRecordViewModelV1"}}}},"401":{"description":"Unauthorized","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Internal Server Error"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.getcakewalk.io/open-api-and-mcp/api-reference/applications/get-workapps-workappid.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.