{"id":9668,"date":"2026-03-20T15:26:53","date_gmt":"2026-03-20T15:26:53","guid":{"rendered":"https:\/\/www.process.st\/help\/?post_type=ht_kb&p=9668"},"modified":"2026-03-20T16:12:04","modified_gmt":"2026-03-20T16:12:04","slug":"restricted-api-keys","status":"publish","type":"ht_kb","link":"https:\/\/www.process.st\/help\/docs\/restricted-api-keys\/","title":{"rendered":"Restricted API keys"},"content":{"rendered":"

Restricted API keys let you scope an API key user’s access to specific resources \u2014 workflows, pages, forms, files, or data sets. Instead of giving an API key full admin access, you can limit it to exactly what it needs.<\/p>\n

Availability:<\/strong> Restricted API keys are available on Enterprise plans.<\/p><\/blockquote>\n

How restricted API keys work<\/h2>\n

Every API key has an associated API key user in your organization. By default, that user is created as an Admin. With restricted API keys, you can change the user’s role and grant access to only the specific resources it needs.<\/p>\n

API key users have a few important properties:<\/p>\n

    \n
  • They’re never added to the All Organization<\/strong> group.<\/li>\n
  • They only see resources you explicitly share with them.<\/li>\n
  • Their role and permissions can be updated at any time.<\/li>\n<\/ul>\n

    Manage API key user access<\/h2>\n

    To view and manage your API key users, go to Users & Guests<\/strong> \u2192 API Key Users<\/strong>.<\/p>\n

    From there you can:<\/p>\n

      \n
    • See all API key users in your organization<\/li>\n
    • Change a API key user’s role<\/li>\n<\/ul>\n

      \"\"<\/p>\n

      Create a restricted API key<\/h2>\n
        \n
      1. Go to Integrations<\/b>.<\/li>\n
      2. Click + New API Key<\/strong>.<\/li>\n
      3. Give the key a name.<\/li>\n
      4. Go to Users & Guests\u00a0<\/strong>and filter by\u00a0API Key Users<\/strong>.<\/li>\n
      5. Set the user’s role. Choose Builder role for the most flexibility.<\/li>\n
      6. Go to the specific workflows, pages, forms, files, or data sets and assign the appropriate permissions to the API key user with the key name you created.<\/li>\n<\/ol>\n

        Frequently asked questions<\/h2>\n

        Can I update an existing API key’s permissions?<\/h3>\n

        Yes. Go to Users & Guests<\/strong> \u2192 API Key Users<\/strong>, find the key, and edit its role, then go to each workflow, form, file, etc and assign the API key user to it. Changes take effect immediately.<\/p>\n

        What happens if I give an API key Admin access?<\/h3>\n

        It behaves the same as a full admin API key. No resources are restricted unless you explicitly limit them.<\/p>\n

        Are API key users counted toward my seat limit?<\/h3>\n

        API key users are separate from your regular user seats. Check your plan details for specifics.<\/p>\n","protected":false},"excerpt":{"rendered":"

        Restricted API keys let you scope an API key user’s access to specific resources \u2014 workflows, pages, forms, files, or data sets. Instead of giving an API key full admin access, you can limit it to exactly what it needs. Availability: Restricted API keys are available on Enterprise plans. How restricted API keys work Every […]<\/p>\n","protected":false},"author":2,"template":"","meta":{"_acf_changed":false,"available_plan":"Enterprise","available_product":"Integrations","footnotes":""},"ht_kb_category":[194],"ht_kb_tag":[],"class_list":["post-9668","ht_kb","type-ht_kb","status-publish","hentry","ht_kb_category-integrations"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/9668","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb"}],"about":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/types\/ht_kb"}],"author":[{"embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/users\/2"}],"version-history":[{"count":6,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/9668\/revisions"}],"predecessor-version":[{"id":9675,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb\/9668\/revisions\/9675"}],"wp:attachment":[{"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/media?parent=9668"}],"wp:term":[{"taxonomy":"ht_kb_category","embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb_category?post=9668"},{"taxonomy":"ht_kb_tag","embeddable":true,"href":"https:\/\/www.process.st\/help\/wp-json\/wp\/v2\/ht_kb_tag?post=9668"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}