All REST Endpoints

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
PATCH	/programs/:id	Update program
DELETE	/programs/:id	Delete program
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
PATCH	/program-groups/:id	Update program group
DELETE	/program-groups/:id	Delete program group
POST	/program-groups/bulk	Bulk actions

Collaborators

Method	Path	Description
GET	/collaborators	List collaborators
GET	/collaborators/:id	Get collaborator
POST	/collaborators	Create collaborator
PATCH	/collaborators/:id	Update collaborator
DELETE	/collaborators/:id	Delete collaborator
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/signup-form-jwt	Create signup form JWT

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
PATCH	/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
PATCH	/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
PATCH	/fulfillments/:id	Update fulfillment
DELETE	/fulfillments/:id	Delete fulfillment
POST	/fulfillments/bulk	Bulk actions

Payouts

Method	Path	Description
GET	/payouts	List payouts
GET	/payouts/:id	Get payout
POST	/payouts/export	Export payouts
POST	/payouts/bulk	Bulk actions

Distributors

Method	Path	Description
GET	/distributors	List distributors
GET	/distributors/:id	Get distributor
POST	/distributors	Create distributor
PATCH	/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

Reporting

Method	Path	Description
GET	/reporting	Query reporting data