Siren

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

MethodPathDescription
GET/programsList programs
GET/programs/:idGet program
POST/programsCreate program
PUT/programs/:idUpdate program
DELETE/programs/:idDelete program
GET/programs/:id/deletion-blockersCheck before deleting
POST/programs/bulkBulk actions
GET/programs/status-typesGet status types
GET/programs/incentive-typesGet incentive types
GET/programs/currency-typesGet currency types

Program Groups

MethodPathDescription
GET/program-groupsList program groups
GET/program-groups/:idGet program group
POST/program-groupsCreate program group
PUT/program-groups/:idUpdate program group
DELETE/program-groups/:idDelete program group
POST/program-groups/bulkBulk actions
GET/collaborators/group-sortersList the registered group sorters

Collaborators

MethodPathDescription
GET/collaboratorsList collaborators
GET/collaborators/:idGet collaborator
POST/collaboratorsCreate collaborator
PUT/collaborators/:idUpdate collaborator
DELETE/collaborators/:idDelete collaborator
GET/collaborators/:id/deletion-blockersCheck before deleting
GET/collaborators/status-typesGet status types
POST/collaborators/generate-referral-codeGenerate referral code
POST/collaborators/bulkBulk actions
POST/collaborators/submit-requestSubmit collaborator request
POST/collaborators/create-signup-form-jwtCreate signup form JWT

Collaborator Groups

MethodPathDescription
GET/collaborator-groupsList groups
GET/collaborator-groups/:idGet group
POST/collaborator-groupsCreate group
PUT/collaborator-groups/:idUpdate group
DELETE/collaborator-groups/:idDelete group
GET/collaborator-groups/:id/membersList members
POST/collaborator-groups/:id/membersAdd members
PUT/collaborator-groups/:id/membersFull-replace members
DELETE/collaborator-groups/:id/members/:collaboratorIdRemove a member
GET/collaborator-groups/structuresList structure resolvers

Engagements

MethodPathDescription
GET/engagementsList engagements
GET/engagements/:idGet engagement
GET/engagements/engagement-typesGet engagement types

Conversions

MethodPathDescription
GET/conversionsList conversions
GET/conversions/:idGet conversion
POST/conversionsCreate conversion
PUT/conversions/:idUpdate conversion
DELETE/conversions/:idDelete conversion
GET/conversions/conversion-typesGet conversion types
POST/conversions/bulkBulk actions

Transactions

MethodPathDescription
GET/transactionsList transactions
GET/transactions/:idGet transaction
POST/transactionsCreate transaction
POST/transactions/credit-collaboratorCredit collaborator
GET/transactions/sourcesGet transaction sources
POST/transactions/bulkBulk actions

Obligations

MethodPathDescription
GET/obligationsList obligations
GET/obligations/:idGet obligation
POST/obligationsCreate obligation
PUT/obligations/:idUpdate obligation
DELETE/obligations/:idDelete obligation
POST/obligations/bulkBulk actions

Fulfillments

MethodPathDescription
GET/fulfillmentsList fulfillments
GET/fulfillments/:idGet fulfillment
POST/fulfillments/generateGenerate fulfillments
PUT/fulfillments/:idUpdate fulfillment
DELETE/fulfillments/:idDelete fulfillment
POST/fulfillments/bulkBulk actions

Currencies

MethodPathDescription
GET/registries/currenciesList registered currencies
GET/currencies/customList custom currencies
POST/currencies/customCreate custom currency
PUT/currencies/custom/:codeUpdate custom currency
DELETE/currencies/custom/:codeDelete custom currency

Store Credit

MethodPathDescription
POST/credits/adjustAdjust a balance
GET/credit-balancesRead balances
GET/credit-entriesList ledger entries

Payouts

MethodPathDescription
GET/payoutsList payouts
GET/payouts/:idGet payout
POST/payouts/exportExport payouts
POST/payouts/bulkBulk actions
POST/payouts/:id/retryRetry payout

Coupons

MethodPathDescription
GET/couponsList coupons
GET/coupons/:idGet a coupon
PATCH/coupons/:idLink, unlink, or rename
POST/couponsAdd a code a store hasn’t sent
DELETE/coupons/:idRemove a coupon
PUT/coupons/linkLink one store’s code
POST/coupons/mergeMerge coupons
POST/coupons/:id/identities/:identityId/splitSplit a store copy off
GET/coupons/suggestionsList merge suggestions
POST/coupons/suggestions/:id/dismissDismiss a suggestion
GET/coupons/storesList stores and their coupon integrations

Customers

MethodPathDescription
GET/customersList customers
GET/customers/:idGet a customer
GET/customers/suggestionsList merge suggestions
POST/customers/suggestions/:id/dismissDismiss a suggestion
POST/customers/mergeMerge customers
POST/customers/:id/identities/:identityId/splitSplit an identity off
POST/customers/:id/collaboratorsLink a customer to a collaborator
DELETE/customers/:id/collaborators/:collaboratorIdUnlink a customer

Products

MethodPathDescription
GET/productsList products
GET/products/listingFind the product for a store’s listing
GET/products/:idGet a product
POST/productsAdd a product a store hasn’t sent
PATCH/products/:idRename a product
PUT/products/:id/ownersSet the owners
GET/products/:id/matchesList merge suggestions
POST/products/:id/matches/:matchId/dismissDismiss a suggestion
POST/products/merge/previewPreview a merge
POST/products/mergeMerge products
POST/products/:id/listings/:listingId/splitSplit 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.

MethodPathDescription
GET/mappingsList mappings
POST/mappingsCreate a mapping
DELETE/mappingsDelete mappings

Autofulfillers

MethodPathDescription
GET/autofulfillers/methodsList payout methods
GET/autofulfillersList autofulfillers
GET/autofulfillers/:currencyGet autofulfiller
POST/autofulfillersCreate autofulfiller
PUT/autofulfillers/:currencyUpdate autofulfiller
DELETE/autofulfillers/:currencyDelete autofulfiller
GET, POST/stripe/configStripe credentials
GET, POST/paypal/configPayPal credentials
POST/stripe/connect/accountsStart Stripe onboarding
GET/stripe/connect/accounts/:collaboratorIdRead Stripe account status
GET/paypal/receivers/:collaboratorIdRead PayPal email
POST/paypal/receiversSet PayPal email
POST/stripe/webhookStripe notices, WordPress only, checked by signature with no login

Distributors

MethodPathDescription
GET/distributorsList distributors
GET/distributors/:idGet distributor
POST/distributorsCreate distributor
PUT/distributors/:idUpdate distributor
DELETE/distributors/:idDelete distributor
POST/distributors/bulkBulk actions

Distributions

MethodPathDescription
GET/distributionsList distributions
GET/distributions/:idGet distribution
POST/distributions/credit-metricCredit metric

Notes

MethodPathDescription
GET/notesList notes for a source
GET/notes/:id/positionGet note position in feed

Reporting

MethodPathDescription
GET/reportingQuery reporting data

Events

MethodPathDescription
POST/track/visitRecord a referred visit from the browser
POST/event/site-visitedReport a site visit
POST/event/saleReport a sale
POST/event/refundReport 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.

MethodPathDescription
GET/pingCheck an API key
GET, POST/api-keysList or create API keys
GET/api-keys/scopesList the scopes a key can hold
DELETE/api-keys/{id}Revoke a key
GET, POST/webhooksList or create webhooks
GET/webhooks/eventsList the events a webhook can subscribe to
GET, PUT, DELETE/webhooks/{id}Read, change, or delete a webhook
GET/webhooks/{id}/deliveriesA webhook’s latest 50 deliveries
POST/webhooks/{id}/testSend a test delivery
POST/payouts/waiting-previewPreview waiting payouts. On WordPress, this route is coming in the next Siren plugin update

Your privacy choices

Account, checkout and chat you request work without optional tracking. Choose whether to allow these other uses on this website.

You can change or withdraw your choices at any time using “Privacy choices.” We remember your choice for 180 days. Read our privacy policy.