API access lets an organisation connect its own tools and workflows to Grabyo. Once access is enabled, authorised users create and manage their own API keys directly from organisation settings, with no manual key creation step from Grabyo.
Getting API access enabled
API access is switched on per organisation. If your organisation wants to use the API, contact your account manager first. Once access is approved, Grabyo sends the API documentation and enables the API section in your organisation settings.
Before you begin
Request API access through your account manager.
Confirm that your organisation has signed the API terms of service.
Wait for confirmation that the API section has been enabled in your organisation settings.
Review the Grabyo API documentation.
How to create an API key
API keys are created and managed in the organisation settings area, after API access has been enabled.
Open your organisation settings and go to the API section.
Select CREATE API KEY.
A new API key is created immediately with default settings and appears in the table.
Open the key’s options menu to review or update its configuration.
📕 Note: Selecting CREATE API KEY does not open a setup form or present configuration options first. The key is created right away using default settings.
✅ Tip: The API DOCUMENTATION button next to it opens the Grabyo API documentation.
How to manage an API key
After a key has been created, manage it from the API section of the organisation page. Select the options menu at the end of the key’s row to see the available actions.
Action | Use it to |
Edit | Change the key’s settings and give it access to Streams and Campaigns. |
Rotate key | Rotate the key. |
Suspend key | Suspend the key. |
Delete key | Delete the key. |
Editing an API key
Selecting Edit opens the Edit API key window, where the key’s Name, Role and access are set. Further settings are available by scrolling down in the same window.
📕 Note: The edit window is the standard Grabyo user modal used elsewhere in the platform. This is expected, because API keys are treated as a user type in Grabyo.
Access to Streams and Campaigns
Creating an API key does not automatically grant access to Streams or Campaigns. Access is added per key, in the API key access area of the edit window.
Open the key’s options menu and select Edit.
Under Stream access, move the streams the key needs from the excluded list on the left to the included list on the right. Type in the filter box to find a stream quickly.
Under Campaign access, do the same for campaigns.
Select APPLY to save.
📕 Note: An ADMIN must specifically add access to Streams and Campaigns for each API key. Until that happens, the key cannot use those resources.
Best practices
Area | Recommendation |
Key creation | Create API keys only for approved integration use cases. |
Key settings | Review settings after creation, since new keys are created with default settings. |
Streams and Campaigns | Grant access only to the resources the integration actually needs. |
Administration | Limit administrative changes to authorised users. |
Implementation | Use the API documentation as the primary reference for implementation details. |


