All REST Endpoints
Complete list of every REST API endpoint in Siren with HTTP method, path, and link to detailed documentation.
Last updated: October 28, 2026
Every REST endpoint available in Siren, organized by resource. All endpoints use the base path /wp-json/siren/v1. Authentication is required unless otherwise noted. See the introduction for authentication, response format, and conventions.
Programs
| Method | Path | Description |
|---|---|---|
| GET | /programs | List programs |
| GET | /programs/:id | Get program |
| POST | /programs | Create program |
| PUT | /programs/:id | Update program |
| DELETE | /programs/:id | Delete program |
| GET | /programs/:id/deletion-blockers | Check before deleting |
| POST | /programs/bulk | Bulk actions |
| GET | /programs/status-types | Get status types |
| GET | /programs/incentive-types | Get incentive types |
| GET | /programs/currency-types | Get currency types |
Program Groups
| Method | Path | Description |
|---|---|---|
| GET | /program-groups | List program groups |
| GET | /program-groups/:id | Get program group |
| POST | /program-groups | Create program group |
| PUT | /program-groups/:id | Update program group |
| DELETE | /program-groups/:id | Delete program group |
| POST | /program-groups/bulk | Bulk actions |
| GET | /collaborators/group-sorters | List the registered group sorters |
Collaborators
| Method | Path | Description |
|---|---|---|
| GET | /collaborators | List collaborators |
| GET | /collaborators/:id | Get collaborator |
| POST | /collaborators | Create collaborator |
| PUT | /collaborators/:id | Update collaborator |
| DELETE | /collaborators/:id | Delete collaborator |
| GET | /collaborators/:id/deletion-blockers | Check before deleting |
| GET | /collaborators/status-types | Get status types |
| POST | /collaborators/generate-referral-code | Generate referral code |
| POST | /collaborators/bulk | Bulk actions |
| POST | /collaborators/submit-request | Submit collaborator request |
| POST | /collaborators/create-signup-form-jwt | Create signup form JWT |
Collaborator Groups
| Method | Path | Description |
|---|---|---|
| GET | /collaborator-groups | List groups |
| GET | /collaborator-groups/:id | Get group |
| POST | /collaborator-groups | Create group |
| PUT | /collaborator-groups/:id | Update group |
| DELETE | /collaborator-groups/:id | Delete group |
| GET | /collaborator-groups/:id/members | List members |
| POST | /collaborator-groups/:id/members | Add members |
| PUT | /collaborator-groups/:id/members | Full-replace members |
| DELETE | /collaborator-groups/:id/members/:collaboratorId | Remove a member |
| GET | /collaborator-groups/structures | List structure resolvers |
Engagements
| Method | Path | Description |
|---|---|---|
| GET | /engagements | List engagements |
| GET | /engagements/:id | Get engagement |
| GET | /engagements/engagement-types | Get engagement types |
Conversions
| Method | Path | Description |
|---|---|---|
| GET | /conversions | List conversions |
| GET | /conversions/:id | Get conversion |
| POST | /conversions | Create conversion |
| PUT | /conversions/:id | Update conversion |
| DELETE | /conversions/:id | Delete conversion |
| GET | /conversions/conversion-types | Get conversion types |
| POST | /conversions/bulk | Bulk actions |
Transactions
| Method | Path | Description |
|---|---|---|
| GET | /transactions | List transactions |
| GET | /transactions/:id | Get transaction |
| POST | /transactions | Create transaction |
| POST | /transactions/credit-collaborator | Credit collaborator |
| GET | /transactions/sources | Get transaction sources |
| POST | /transactions/bulk | Bulk actions |
Obligations
| Method | Path | Description |
|---|---|---|
| GET | /obligations | List obligations |
| GET | /obligations/:id | Get obligation |
| POST | /obligations | Create obligation |
| PUT | /obligations/:id | Update obligation |
| DELETE | /obligations/:id | Delete obligation |
| POST | /obligations/bulk | Bulk actions |
Fulfillments
| Method | Path | Description |
|---|---|---|
| GET | /fulfillments | List fulfillments |
| GET | /fulfillments/:id | Get fulfillment |
| POST | /fulfillments/generate | Generate fulfillments |
| PUT | /fulfillments/:id | Update fulfillment |
| DELETE | /fulfillments/:id | Delete fulfillment |
| POST | /fulfillments/bulk | Bulk actions |
Currencies
| Method | Path | Description |
|---|---|---|
| GET | /registries/currencies | List registered currencies |
| GET | /currencies/custom | List custom currencies |
| POST | /currencies/custom | Create custom currency |
| PUT | /currencies/custom/:code | Update custom currency |
| DELETE | /currencies/custom/:code | Delete custom currency |
Store Credit
| Method | Path | Description |
|---|---|---|
| POST | /credits/adjust | Adjust a balance |
| GET | /credit-balances | Read balances |
| GET | /credit-entries | List ledger entries |
Payouts
| Method | Path | Description |
|---|---|---|
| GET | /payouts | List payouts |
| GET | /payouts/:id | Get payout |
| POST | /payouts/export | Export payouts |
| POST | /payouts/bulk | Bulk actions |
| POST | /payouts/:id/retry | Retry payout |
Coupons
| Method | Path | Description |
|---|---|---|
| GET | /coupons | List coupons |
| GET | /coupons/:id | Get a coupon |
| PATCH | /coupons/:id | Link, unlink, or rename |
| POST | /coupons | Add a code a store hasn’t sent |
| DELETE | /coupons/:id | Remove a coupon |
| PUT | /coupons/link | Link one store’s code |
| POST | /coupons/merge | Merge coupons |
| POST | /coupons/:id/identities/:identityId/split | Split a store copy off |
| GET | /coupons/suggestions | List merge suggestions |
| POST | /coupons/suggestions/:id/dismiss | Dismiss a suggestion |
| GET | /coupons/stores | List stores and their coupon integrations |
Customers
| Method | Path | Description |
|---|---|---|
| GET | /customers | List customers |
| GET | /customers/:id | Get a customer |
| GET | /customers/suggestions | List merge suggestions |
| POST | /customers/suggestions/:id/dismiss | Dismiss a suggestion |
| POST | /customers/merge | Merge customers |
| POST | /customers/:id/identities/:identityId/split | Split an identity off |
| POST | /customers/:id/collaborators | Link a customer to a collaborator |
| DELETE | /customers/:id/collaborators/:collaboratorId | Unlink a customer |
Products
| Method | Path | Description |
|---|---|---|
| GET | /products | List products |
| GET | /products/listing | Find the product for a store’s listing |
| GET | /products/:id | Get a product |
| POST | /products | Add a product a store hasn’t sent |
| PATCH | /products/:id | Rename a product |
| PUT | /products/:id/owners | Set the owners |
| GET | /products/:id/matches | List merge suggestions |
| POST | /products/:id/matches/:matchId/dismiss | Dismiss a suggestion |
| POST | /products/merge/preview | Preview a merge |
| POST | /products/merge | Merge products |
| POST | /products/:id/listings/:listingId/split | Split a listing off |
Mappings
Product owner calls on these routes, where externalType ends in _product, are deprecated in favor of the /products routes. See Mappings.
| Method | Path | Description |
|---|---|---|
| GET | /mappings | List mappings |
| POST | /mappings | Create a mapping |
| DELETE | /mappings | Delete mappings |
Autofulfillers
| Method | Path | Description |
|---|---|---|
| GET | /autofulfillers/methods | List payout methods |
| GET | /autofulfillers | List autofulfillers |
| GET | /autofulfillers/:currency | Get autofulfiller |
| POST | /autofulfillers | Create autofulfiller |
| PUT | /autofulfillers/:currency | Update autofulfiller |
| DELETE | /autofulfillers/:currency | Delete autofulfiller |
| GET, POST | /stripe/config | Stripe credentials |
| GET, POST | /paypal/config | PayPal credentials |
| POST | /stripe/connect/accounts | Start Stripe onboarding |
| GET | /stripe/connect/accounts/:collaboratorId | Read Stripe account status |
| GET | /paypal/receivers/:collaboratorId | Read PayPal email |
| POST | /paypal/receivers | Set PayPal email |
| POST | /stripe/webhook | Stripe notices, WordPress only, checked by signature with no login |
Distributors
| Method | Path | Description |
|---|---|---|
| GET | /distributors | List distributors |
| GET | /distributors/:id | Get distributor |
| POST | /distributors | Create distributor |
| PUT | /distributors/:id | Update distributor |
| DELETE | /distributors/:id | Delete distributor |
| POST | /distributors/bulk | Bulk actions |
Distributions
| Method | Path | Description |
|---|---|---|
| GET | /distributions | List distributions |
| GET | /distributions/:id | Get distribution |
| POST | /distributions/credit-metric | Credit metric |
Notes
| Method | Path | Description |
|---|---|---|
| GET | /notes | List notes for a source |
| GET | /notes/:id/position | Get note position in feed |
Reporting
| Method | Path | Description |
|---|---|---|
| GET | /reporting | Query reporting data |
Events
| Method | Path | Description |
|---|---|---|
| POST | /track/visit | Record a referred visit from the browser |
| POST | /event/site-visited | Report a site visit |
| POST | /event/sale | Report a sale |
| POST | /event/refund | Report a refund |
Siren Cloud also serves these routes under https://api.sirenaffiliates.com/siren/v1. The /api-keys routes take a signed-in Admin, never an API key. An API key reaches event ingestion and the ledger, webhook, and record routes its scopes name, such as products, coupons, collaborators, and programs, as API Keys lists. Every other route needs a signed-in person.
| Method | Path | Description |
|---|---|---|
| GET | /ping | Check an API key |
| GET, POST | /api-keys | List or create API keys |
| GET | /api-keys/scopes | List the scopes a key can hold |
| DELETE | /api-keys/{id} | Revoke a key |
| GET, POST | /webhooks | List or create webhooks |
| GET | /webhooks/events | List the events a webhook can subscribe to |
| GET, PUT, DELETE | /webhooks/{id} | Read, change, or delete a webhook |
| GET | /webhooks/{id}/deliveries | A webhook’s latest 50 deliveries |
| POST | /webhooks/{id}/test | Send a test delivery |
| POST | /payouts/waiting-preview | Preview waiting payouts. On WordPress, this route is coming in the next Siren plugin update |