API v1 (OAuth apps)
API v1 resource list
Every API v1 operation that is served today, with the scopes it needs and whether it also has the agency creator-path form.
View as MarkdownUpdated Nov 1, 2026
Generated from the routes themselves, so it lists exactly what is served. Paths are relative to https://api.dropfans.io/v1; every operation is also served under /v0 and unprefixed (page/size paging) unless marked “v1 only”. “Creator path” means the operation is also served at /creators/{creatorUserUuid}<path> for an agency acting for a creator, with the extra scopes shown. Paths that are not listed answer 404 {"message": "Resource not found"}.
109 operations.
Account and audience#
| Method | Path | Scopes | Also |
|---|---|---|---|
GET | /creators/{creatorUserUuid}/account | read:creator | creator path only |
GET | /creators/{creatorUserUuid}/blocks | read:creator read:chat read:fan | creator path only |
POST | /creators/{creatorUserUuid}/blocks/{userUuid} | write:chat read:creator | creator path only |
DELETE | /creators/{creatorUserUuid}/blocks/{userUuid} | write:chat read:creator | creator path only |
PATCH | /creators/{creatorUserUuid}/subscription-price | write:creator | creator path only |
GET | /followers | read:fan | creator path (+ read:creator) |
GET | /subscribers | read:fan | creator path (+ read:creator) |
GET | /subscribers/{userUuid} | read:fan | creator path (+ read:creator) |
GET | /subscribers/{userUuid}/history | read:fan | creator path (+ read:creator); v1 only |
GET | /users/account | read:self | — |
GET | /users/me | read:self | — |
PATCH | /users/me/subscription-price | write:creator | — |
Agencies and creators#
| Method | Path | Scopes | Also |
|---|---|---|---|
POST | /agencies/creator-invites | write:agency | — |
GET | /agencies/earnings | read:agency read:creator | — |
GET | /agencies/followers-history | read:agency read:creator | — |
GET | /agencies/subscribers | read:agency read:creator | — |
GET | /agencies/subscribers-history | read:agency read:creator | — |
GET | /creators | read:creator | — |
Insights#
| Method | Path | Scopes | Also |
|---|---|---|---|
GET | /insights/earnings | read:insights | creator path (+ read:creator) |
GET | /insights/earnings/summary | read:insights | creator path (+ read:creator) |
GET | /insights/fans | read:insights read:fan | creator path (+ read:creator) |
GET | /insights/fans/{userUuid} | read:insights read:fan | creator path (+ read:creator) |
POST | /insights/fans/batch | read:insights read:fan | creator path (+ read:creator) |
POST | /insights/fans/profiles | read:fan | — |
GET | /insights/spending | read:insights | creator path (+ read:creator) |
GET | /insights/subscribers | read:insights | creator path (+ read:creator) |
GET | /insights/top-spenders | read:insights read:fan | creator path (+ read:creator) |
Media and vault#
| Method | Path | Scopes | Also |
|---|---|---|---|
GET | /media | read:media | creator path |
GET | /media/{uuid} | read:media | creator path |
PATCH | /media/{uuid} | write:media | creator path |
DELETE | /media/{uuid} | write:media | creator path |
GET | /media/bulk | read:media | creator path |
POST | /media/uploads | write:media | creator path |
PATCH | /media/uploads/{uploadId} | write:media | creator path |
GET | /media/uploads/{uploadId}/parts/{partNumber}/url | write:media | creator path |
GET | /media/uploads/{uploadId}/parts/urls | write:media | creator path |
GET | /vault/folders | read:media | creator path |
POST | /vault/folders | write:media | creator path |
GET | /vault/folders/{folderName} | read:media | creator path |
PATCH | /vault/folders/{folderName} | write:media | creator path |
DELETE | /vault/folders/{folderName} | write:media | creator path |
GET | /vault/folders/{folderName}/media | read:media | creator path |
POST | /vault/folders/{folderName}/media | write:media | creator path |
PATCH | /vault/folders/{folderName}/media/{mediaUuid} | write:media | — |
DELETE | /vault/folders/{folderName}/media/{mediaUuid} | write:media | creator path |
Posts#
| Method | Path | Scopes | Also |
|---|---|---|---|
POST | /agencies/posts | write:post write:creator | — |
GET | /posts | read:post | creator path |
POST | /posts | write:post | creator path |
GET | /posts/{uuid} | read:post | creator path |
PATCH | /posts/{uuid} | write:post | creator path |
DELETE | /posts/{uuid} | write:post | creator path |
GET | /posts/{uuid}/comments | read:post | creator path |
POST | /posts/{uuid}/comments | write:post | creator path |
DELETE | /posts/{uuid}/comments/{commentUuid} | write:post | creator path |
GET | /posts/{uuid}/likes | read:post | creator path |
Media links#
| Method | Path | Scopes | Also |
|---|---|---|---|
GET | /media-links | read:creator | — |
POST | /media-links | write:creator | — |
DELETE | /media-links/{uuid} | write:creator | — |
Tracking links#
| Method | Path | Scopes | Also |
|---|---|---|---|
GET | /tracking-links | read:tracking_links | creator path |
POST | /tracking-links | write:tracking_links | creator path |
DELETE | /tracking-links/{uuid} | write:tracking_links | creator path |
GET | /tracking-links/{uuid}/users | read:tracking_links | creator path |
Onboarding#
| Method | Path | Scopes | Also |
|---|---|---|---|
POST | /onboarding/creators | write:creator | — |
Webhooks#
| Method | Path | Scopes | Also |
|---|---|---|---|
GET | /webhooks/subscriptions | read:self | — |
POST | /webhooks/subscriptions | read:self | — |
DELETE | /webhooks/subscriptions/{id} | read:self | — |
POST | /webhooks/test | read:self | — |
Chat (available once chat is enabled)#
| Method | Path | Scopes | Also |
|---|---|---|---|
GET | /agencies/chats | read:agency read:chat | — |
POST | /agencies/chats/messages/batch | read:agency read:chat | — |
GET | /chats | read:chat | creator path (+ read:creator) |
POST | /chats | write:chat | creator path (+ read:creator) |
GET | /chats/{userUuid} | read:chat | — |
PATCH | /chats/{userUuid} | write:chat | creator path (+ read:creator) |
GET | /chats/{userUuid}/media | read:chat | creator path (+ read:creator) |
POST | /chats/{userUuid}/message | write:chat | creator path (+ read:creator) |
GET | /chats/{userUuid}/messages | read:chat | creator path (+ read:creator) |
GET | /chats/{userUuid}/messages/{messageUuid} | read:chat | — |
DELETE | /chats/{userUuid}/messages/{messageUuid} | write:chat | creator path (+ read:creator) |
GET | /chats/{userUuid}/messages/{messageUuid}/media | read:chat | creator path (+ read:creator) |
GET | /chats/{userUuid}/notes | read:chat read:fan | creator path (+ read:creator) |
PUT | /chats/{userUuid}/notes | write:chat | creator path (+ read:creator) |
POST | /chats/{userUuid}/typing | write:chat | — |
GET | /chats/automated-messages | read:creator | creator path |
PUT | /chats/automated-messages/{trigger} | write:creator | creator path |
DELETE | /chats/automated-messages/{trigger} | write:creator | creator path |
GET | /chats/lists/custom | read:chat read:fan | creator path (+ read:creator) |
POST | /chats/lists/custom | write:chat | creator path (+ read:creator) |
GET | /chats/lists/custom/{uuid} | read:chat read:fan | creator path (+ read:creator) |
PATCH | /chats/lists/custom/{uuid} | write:chat | creator path (+ read:creator) |
DELETE | /chats/lists/custom/{uuid} | write:chat | creator path (+ read:creator) |
POST | /chats/lists/custom/{uuid}/members | write:chat | creator path (+ read:creator) |
DELETE | /chats/lists/custom/{uuid}/members/{userUuid} | write:chat | creator path (+ read:creator) |
GET | /chats/lists/smart | read:chat read:fan | creator path (+ read:creator) |
GET | /chats/lists/smart/{uuid} | read:chat read:fan | creator path (+ read:creator) |
GET | /chats/mass-messages | read:chat | creator path (+ read:creator) |
POST | /chats/mass-messages | write:chat read:fan | creator path (+ read:creator) |
PATCH | /chats/mass-messages/{messageUuid} | write:chat | creator path (+ read:creator) |
DELETE | /chats/mass-messages/{messageUuid} | write:chat | creator path (+ read:creator) |
POST | /chats/messages/batch | read:chat | creator path (+ read:creator) |
POST | /chats/statuses | read:chat | creator path (+ read:creator) |
GET | /chats/templates | read:chat | creator path (+ read:creator) |
POST | /chats/templates | write:chat | — |
GET | /chats/templates/{templateUuid} | read:chat | creator path (+ read:creator) |
DELETE | /chats/templates/{templateUuid} | write:chat | — |
GET | /chats/templates/folders | read:chat | creator path (+ read:creator) |
POST | /chats/templates/folders | write:chat | — |
PATCH | /chats/templates/folders/{folderUuid} | write:chat | — |
GET | /chats/unread | read:chat | creator path (+ read:creator) |
GET | /creators/{creatorUserUuid}/subscribers/online | read:creator read:fan | creator path only |
Questions? support@dropfans.io