Skip to main content

How do I get my API key?

Find an organization API key, plan a supported key replacement, and review available audit and call-log records without exposing credentials.

System administrators can obtain their organization’s API key in the integrations settings. Developers can use the key for authorized requests described in the Yeeflow Open API documentation. Store the key in the approved server-side secret store used by the integration.

Plan key replacement with the integration owners. The original guide recommends considering a six-month rotation interval. Replacing a key deactivates the earlier key, so coordinate the update of dependent integrations.

The original guide describes the following reminders for Super Admins and the user who last created or rotated a key:

  • At five months: an email reminder.

  • At six months: a sidebar reminder.

  • After six months without rotation: email and sidebar reminders every six months.

Confirm the current key-age indicator and reminder behavior available in your organization before relying on that schedule. Arrange maintenance for dependent services and verify their requests after a key change.

Access your API key

  • Use a system administrator account and open your organization’s system settings.

  • Navigate to Integrations → API key.

  • If no key has been generated, use Generate API key if that action is available, then follow the page’s confirmation flow.

  • For an existing key, use Show if present to display it.

  • Use Copy and save the key directly in the approved server-side secret store for the authorized integration. Configure API requests according to the Open API documentation.

  • Before replacing or deactivating a key, identify dependent integrations and arrange how their stored secret will be updated.

    • Open Actions where your interface provides that menu. Check the operation and confirmation for the key you intend to maintain.

    • In the documented rotation flow, choose Rotate key, then Rotate and expire this key now. Complete a verification challenge, including reCAPTCHA, only if the page requires it. Confirming replacement deactivates the existing key; requests that continue using it will fail.

      After rotation, use Copy to store the replacement key for the authorized integrations, then check their intended API requests.

    • To stop using a key, choose Deactivate key and Deactivate this key now if those actions are offered. Complete verification if required. Requests using the deactivated key will no longer be authorized.

  • Use the Audit log section, where available, to review dated records of who viewed, created, or deactivated the key. Compare the entries with your maintenance activity.

View your API key call log

The original guide documents a Call log view for the previous seven days. Check the available date range and entries in your account when reviewing an integration change.

  • Open your organization’s system settings with a system administrator account.

  • Navigate to Integrations → API key.

  • Open the Call log tab and inspect the available request activity. Compare relevant times with the authorized integration’s server-side logs.

Call log tab from the original English API key settings screenshot; no key value or request records are shown.

This crop shows only the Call log tab in the original English help-center image. Its capture date and product build are unknown; it does not show a key value or a completed API call.

Did this answer your question?