API reference
Endpoint reference
Discovery and auth
| Method | Path | Authentication |
|---|---|---|
| GET | /v1 | None |
| GET | /v1/openapi.json | None |
| GET | /v1/postman-collection.json | None |
| GET | /v1/scopes | None |
| GET | /v1/mcp/tools | None |
| POST | /v1/auth/introspect | Managed key |
Business resources
| Method | Path | Scope resource/action | Notes |
|---|---|---|---|
| GET | /v1/organization/profile | organization:read | Workspace context |
| PATCH | /v1/organization/profile | organization:write | Own workspace profile fields only |
| GET | /v1/creators | creator:read | Connected creator roster |
| GET | /v1/creators/{creatorId} | creator:read | Exact roster creator |
| GET | /v1/explore/creators | creator:read | Marketplace-listed creators |
| GET | /v1/programs | programs:read | Workspace programs |
| PATCH | /v1/programs/{programId}/creators/{reviewId} | programs:review | Application decision |
| GET | /v1/creatives | submissions:read | Submission and review state |
| GET | /v1/creatives/{creativeId} | submissions:read | Exact submission |
| PATCH | /v1/creatives/{creativeId} | submissions:review | Review status and optional note |
| GET | /v1/commerce/products | products:read | Products and sample availability |
| GET | /v1/paid-campaigns | ads:read | Paid campaign plans and state |
| GET | /v1/paid-campaigns/{campaignId} | ads:read | Exact paid campaign |
| GET | /v1/analytics/summary | analytics:read | Scoped performance summary |
| GET | /v1/finance/summary | finance:read | Scoped finance summary |
Prefix the scope resource/action with the key actor, for example brand:programs:read or partner:programs:read.
Query parameters
List endpoints accept limit, cursor, and query where applicable. Summary endpoints also accept ISO-date from and to. Agency requests use client as described in Agency client access.
Profile update
PATCH /v1/organization/profile accepts any non-empty subset of:
name;imageUrl;publicDescription;creatorRecruitmentHeadline;creatorRecruitmentDescription.
Invite links, membership, billing, and integration settings are not writable here.
Review a submission
{
"status": "Revision",
"note": "Trim the introduction to three seconds."
}
Status accepts Review, Revision, Approved, Live, or Rejected.
Review a program application
{ "status": "Approved" }
Status accepts Applied, Approved, or Rejected. Both review endpoints call the same domain handlers and capability checks as Lucra's UI.