beehiiv Developer Documentation

Retrieve the permissions granted to the OAuth or API token for this workspace. API keys return all granular OAuth scopes. OAuth tokens return only the scopes they were authorized for.

posts write access is only included when the Send API feature is enabled; tokens with posts:write but without Send API receive posts as ["read"].

Retrieve the permissions granted to the OAuth or API token for this workspace. API keys return all granular OAuth scopes. OAuth tokens return only the scopes they were authorized for.<br><br> `posts` write access is only included when the Send API feature is enabled; tokens with `posts:write` but without Send API receive `posts` as `["read"]`.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

datamap from strings to lists of enums

A map of OAuth resources to the permission actions granted for each. Keys are resource names (e.g. posts, segments) and values are arrays of granted actions (read and/or write). API keys receive all granular OAuth scopes. OAuth tokens receive only the scopes they were authorized for. posts write access is only included when the Send API feature is enabled for the workspace; if the token has posts:write but Send API is disabled, posts is returned as ["read"].

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

1	{
2	"data": {
3	"identify": [
4	"read"
5	],
6	"posts": [
7	"read",
8	"write"
9	],
10	"segments": [
11	"read",
12	"write"
13	],
14	"subscriptions": [
15	"read"
16	]
17	}
18	}