Skip to main content
You need an Owner or Admin account with permission to manage integrations in the workspace.

Create a key

  1. Sign in and open the workspace you want to manage.
  2. Open Settings → API Keys → Workspace / Platform API Key.
  3. Enter a name, such as Inventory integration.
  4. Choose an expiry, or Never expire. Never-expiring keys remain valid until revoked.
  5. Select Choose permissions and enable only the operations your integration needs.
  6. Select Create Platform key.
  7. Copy and securely save the key. The full key is shown only once.
Each workspace can have up to 20 active Platform keys. Existing keys keep their original expiry unless you replace them.
Keep the key private. Do not publish it in source code, URLs, screenshots or browser scripts. Use Postman or your backend. Rotate long-lived keys regularly.

View permissions

The key list shows the name, masked key, expiry and status. Select View details below a key’s name to open its permissions.

Choose the right permissions

Screen controls have their own permissions, such as screens.playback and screens.delivery. Schedule creation and updates also require publications.execute. The endpoint reference lists exact requirements. Selecting a permission does not give your account a higher role. Workspace publishing rules and approval requirements still apply.

Replace or revoke a key

To rotate a key, create a replacement, update your integration, confirm it works, then revoke the old key. Revocation is immediate and cannot be undone. Uploads and operation results created with the old key may not be accessible with its replacement. Finish or cancel pending work before rotation where possible.

Troubleshooting

  • Create disabled: check that the API is available and your account can manage integrations.
  • Key rejected: check expiry, revocation, selected permissions and workspace ID.
  • Full key not visible: create a replacement; Layarva cannot show it again.
  • Widget integration: use the separate Widget API Key, not a Platform key.