API

Operation reference

Every operation of the ReuseForge API v1: parameters, request and response bodies, scopes, rate tier and examples in curl, Python, JavaScript and the CLI.

72 operations in 13 areas. Type in the box to filter by name, path, operation ID, CLI command or MCP tool.

All operations
Operation	Request	Operation ID	Scopes	Tier	CLI	On reuseforge.com
API index	`GET /`	`get_api_index`	none	`read`	`rf api index`	yes
Health check	`GET /health`	`get_health`	none	`read`	`rf api health`	yes
This contract	`GET /openapi.{format}`	`get_openapi_document`	none	`read`	`rf api openapi`	yes
Webhook event catalogue	`GET /event-types`	`list_event_types`	none	`read`	`rf events types`	yes
Rate limit status	`GET /rate-limit`	`get_rate_limits`	none	`read`	`rf api rate-limit`	yes
Who am I	`GET /me`	`get_me`	none	`read`	`rf whoami`	yes
Get a public profile	`GET /accounts/{handle}`	`get_account`	none	`read`	`rf accounts get`	yes
List API tokens	`GET /tokens`	`list_tokens`	`tokens:manage`	`read`	`rf tokens list`	yes
Create an API token	`POST /tokens`	`create_token`	`tokens:manage`	`write`	`rf tokens create`	yes
Revoke an API token	`DELETE /tokens/{token_id}`	`revoke_token`	`tokens:manage`	`write`	`rf tokens revoke`	yes
Search and list items	`GET /items`	`search_items`	none	`read`	`rf items search`	yes
Create an item	`POST /items`	`create_item`	`items:write`	`write`	`rf items create`	yes
Get an item	`GET /items/{owner}/{slug}`	`get_item`	none	`read`	`rf items get`	yes
Update an item	`PATCH /items/{owner}/{slug}`	`update_item`	`items:write`	`write`	`rf items update`	yes
Retract an item	`DELETE /items/{owner}/{slug}`	`retract_item`	`items:write`	`write`	`rf items retract`	yes
Star an item	`PUT /items/{owner}/{slug}/star`	`star_item`	`items:write`	`write`	`rf items star`	yes
Remove your star	`DELETE /items/{owner}/{slug}/star`	`unstar_item`	`items:write`	`write`	`rf items unstar`	yes
Item statistics	`GET /items/{owner}/{slug}/stats`	`get_item_stats`	none	`read`	`rf items stats`	yes
List reviews	`GET /items/{owner}/{slug}/reviews`	`list_reviews`	none	`read`	`rf reviews list`	yes
Review an item	`POST /items/{owner}/{slug}/reviews`	`create_review`	`items:write`	`write`	`rf reviews create`	yes
Delete your review	`DELETE /items/{owner}/{slug}/reviews/mine`	`delete_review`	`items:write`	`write`	`rf reviews delete`	yes
Install descriptor	`GET /items/{owner}/{slug}/install`	`get_install_descriptor`	none	`read`	`rf items descriptor`	yes
List versions	`GET /items/{owner}/{slug}/versions`	`list_versions`	none	`read`	`rf versions list`	yes
Publish a version	`POST /items/{owner}/{slug}/versions`	`publish_version`	`items:publish`	`write`	`rf versions publish`	yes
Get a version	`GET /items/{owner}/{slug}/versions/{version}`	`get_version`	none	`read`	`rf versions get`	yes
Yank or restore a version	`PATCH /items/{owner}/{slug}/versions/{version}`	`update_version`	`items:publish`	`write`	`rf versions yank`	yes
Download a version	`GET /items/{owner}/{slug}/versions/{version}/bundle`	`get_version_bundle`	none	`read`	`rf versions download`	yes
Download a version as a ZIP archive	`GET /items/{owner}/{slug}/versions/{version}/archive.zip`	`get_version_archive`	none	`read`	`rf versions download --format zip`	yes
Claude Code plugin marketplace of an owner	`GET /marketplaces/{owner}.json`	`get_marketplace`	none	`read`	`rf marketplaces get`	yes
Request a verification run	`POST /items/{owner}/{slug}/versions/{version}/verifications`	`request_verification`	`items:publish`	`write`	`rf verify request`	yes
Get a verification	`GET /verifications/{verification_id}`	`get_verification`	none	`read`	`rf verify get`	yes
Plan a goal	`POST /plans`	`plan_goal`	none	`plan`	`rf plan`	yes
Get a plan	`GET /plans/{plan_id}`	`get_plan`	none	`read`	`rf plans get`	yes
Build brief for the parts to build	`GET /plans/{plan_id}/brief`	`build_brief`	none	`read`	`rf plans brief`	yes
Discover external candidates	`GET /discover`	`discover_external`	none	`discover`	`rf discover`	yes
MCP configuration for a goal	`GET /mcp-config`	`get_mcp_config`	none	`read`	`rf mcp-config`	yes
List connectors	`GET /connectors`	`list_connectors`	none	`read`	`rf connectors list`	yes
List your orders	`GET /orders`	`list_orders`	`orders:read`	`read`	`rf orders list`	yes
Create an order	`POST /orders`	`create_order`	`orders:create`	`payments`	`rf orders create`	yes
Get an order	`GET /orders/{order_id}`	`get_order`	`orders:read`	`read`	`rf orders get`	yes
Fund an order	`POST /orders/{order_id}/pay`	`pay_order`	`orders:pay`	`payments`	`rf orders pay`	yes
Cancel an unpaid order	`POST /orders/{order_id}/cancel`	`cancel_order`	`orders:create`	`write`	`rf orders cancel`	yes
Deliver sold items (seller)	`POST /orders/{order_id}/deliver`	`deliver_order`	`orders:create`	`write`	`rf orders deliver`	yes
Accept delivery and release escrow	`POST /orders/{order_id}/accept`	`accept_order`	`orders:accept`	`payments`	`rf orders accept`	yes
Dispute delivered items	`POST /orders/{order_id}/dispute`	`dispute_order`	`orders:create`	`write`	`rf orders dispute`	yes
Refund an item (seller)	`POST /orders/{order_id}/items/{item_id}/refund`	`refund_order_item`	`orders:create`	`payments`	`rf orders refund`	yes
Resolve a dispute (arbiter)	`POST /orders/{order_id}/items/{item_id}/resolve`	`resolve_order_item`	`admin`	`payments`	`rf admin resolve`	yes
List payouts	`GET /payouts`	`list_payouts`	`orders:read`	`read`	`rf payouts list`	yes
Seller earnings summary	`GET /earnings`	`get_earnings`	`orders:read`	`read`	`rf payouts earnings`	yes
List crowdfunded projects	`GET /projects`	`list_projects`	none	`read`	`rf projects list`	not yet
Propose a crowdfunded project	`POST /projects`	`create_project`	`projects:write`	`write`	`rf projects create`	not yet
Get a project	`GET /projects/{project_id}`	`get_project`	none	`read`	`rf projects get`	not yet
Back a project	`POST /projects/{project_id}/backings`	`back_project`	`projects:write`, `orders:pay`	`payments`	`rf projects back`	not yet
Withdraw a pledge	`DELETE /projects/{project_id}/backings/{backing_id}`	`withdraw_backing`	`projects:write`	`payments`	`rf projects withdraw`	not yet
Deliver a milestone (developer)	`POST /projects/{project_id}/milestones/{index}/delivery`	`deliver_milestone`	`projects:write`	`write`	`rf projects deliver`	not yet
Vote on a milestone (backer)	`POST /projects/{project_id}/milestones/{index}/votes`	`vote_milestone`	`projects:write`	`write`	`rf projects vote`	not yet
Finalize a milestone vote	`POST /projects/{project_id}/milestones/{index}/finalize`	`finalize_milestone`	`projects:write`	`write`	`rf projects finalize`	not yet
Vote to abort a funded project	`POST /projects/{project_id}/abort-votes`	`vote_abort`	`projects:write`	`write`	`rf projects abort`	not yet
Transfer revenue units	`POST /projects/{project_id}/transfers`	`transfer_units`	`projects:write`	`payments`	`rf projects transfer`	not yet
Attach the finished product	`PUT /projects/{project_id}/product`	`attach_product`	`projects:write`	`write`	`rf projects attach`	not yet
Project portfolio	`GET /portfolio`	`get_portfolio`	`projects:read`	`read`	`rf portfolio`	not yet
List webhooks	`GET /webhooks`	`list_webhooks`	`webhooks:manage`	`read`	`rf webhooks list`	yes
Create a webhook	`POST /webhooks`	`create_webhook`	`webhooks:manage`	`write`	`rf webhooks create`	yes
Get a webhook	`GET /webhooks/{webhook_id}`	`get_webhook`	`webhooks:manage`	`read`	`rf webhooks get`	yes
Update a webhook	`PATCH /webhooks/{webhook_id}`	`update_webhook`	`webhooks:manage`	`write`	`rf webhooks update`	yes
Delete a webhook	`DELETE /webhooks/{webhook_id}`	`delete_webhook`	`webhooks:manage`	`write`	`rf webhooks delete`	yes
Rotate the signing secret	`POST /webhooks/{webhook_id}/rotate-secret`	`rotate_webhook_secret`	`webhooks:manage`	`write`	`rf webhooks rotate-secret`	yes
Send a test ping	`POST /webhooks/{webhook_id}/test`	`test_webhook`	`webhooks:manage`	`write`	`rf webhooks test`	yes
List deliveries	`GET /webhooks/{webhook_id}/deliveries`	`list_webhook_deliveries`	`webhooks:manage`	`read`	`rf webhooks deliveries`	yes
Redeliver an event	`POST /webhooks/{webhook_id}/deliveries/{delivery_id}/redeliver`	`redeliver_webhook`	`webhooks:manage`	`write`	`rf webhooks redeliver`	yes
Read the signed event feed	`GET /ledger/events`	`list_ledger_events`	none	`read`	`rf ledger pull`	not yet
Push signed events	`POST /ledger/events`	`post_ledger_events`	`items:write`	`write`	`rf ledger push`	not yet