Fellow's API uses API key authentication to authorize requests. All API requests must include a valid API key in the Authorization header.
Getting an API Key
Before you can make API requests, you'll need to obtain an API key:
- Log into your Fellow account.
- Navigate to the Developer API settings section in your User settings.
- Generate a new API key for your application, giving it a descriptive name. You can have multiple API keys, and we recommend generating a different one for each application you'll use it in.
- Store the API key securely - it will only be shown once.
Enabling the Developer APIIf the Developer API section is not available in your User settings, the API may not be enabled in your workspace yet. An admin in your workspace will need to enable the API in the Security section of the workspace settings. Learn more about how to enable the API here.
Workspace admins cannot access individual users' API keys, but may see names, who created them, when they were last used, and disable them.
Making Authenticated Requests
Include your API key in the X-API-KEY
header of every request:
X-API-KEY:
{API_KEY}
Example authenticated request (replace {subdomain}
with your workspace's subdomain):
curl -X GET \
https://{subdomain}.fellow.app/api/v1/me \
-H "X-API-KEY: abc123"
Unauthenticated requests will receive an Unauthorized 401
response.
Access Rules
The same access rules that apply in Fellow, apply through the Developer API: the only resources that are available to an API Key are the same ones that are available to the API Key's owner in the interface. Resources may be accessible to someone through a variety of methods, for example:
- They are an attendee of the event related to the object.
- The object (Note, Recording) was explicitly shared with them by an attendee of the event.
- They are in a channel where the object was published by an attendee of the event.