GET /WorkApps/{workAppId}/CustomFields

Returns a paginated list of available Custom Fields for a specific Work App.

get

Authorizations

API Key

Path parameters

workAppIdstring · uuidRequired

The Work App's unique identifier.

Query parameters

cursorstringOptional

Optional pagination cursor for fetching the next page of results. Refer to the pagination section in the documentation for usage details.

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

text/plainapplication/jsontext/json

401

Unauthorized

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

500

Internal Server Error

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /api/v1/WorkApps/{workAppId}/CustomFields 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",
      "type": "text",
      "required": true,
      "value": "text"
    }
  ],
  "links": {
    "self": "text",
    "next": "text"
  }
}