Skip to content
Pile
Esc
↑↓navigate↵open⌘Jpreview

List support widget keys

GET/workspaces/{organizationId}/support/widget-keys
Path parameters
organizationIdstringrequired
Responses
200

Widget keys

widgetKeysobject[]required
Show properties
Array of object
idstringrequired
organizationIdstringrequired
keystringrequired
hmacSecretstringrequired
namestringrequired
allowedOriginsstring[]required
greetingstring | nullrequired
brandColorstring | nullrequired
requireEmailbooleanrequired
requireChallengebooleanrequired
isActivebooleanrequired
createdBystring | nullrequired
createdAtstringrequired
updatedAtstringrequired
Try it
Server
Parameters
Request
curl -X GET '/workspaces/string/support/widget-keys'
Response
{
  "widgetKeys": [
    {
      "id": "string",
      "organizationId": "string",
      "key": "string",
      "hmacSecret": "string",
      "name": "string",
      "allowedOrigins": [
        "string"
      ],
      "greeting": "string",
      "brandColor": "string",
      "requireEmail": true,
      "requireChallenge": true,
      "isActive": true,
      "createdBy": "string",
      "createdAt": "string",
      "updatedAt": "string"
    }
  ]
}