All resources
Every resource the Partners API exposes, with its REST path and a link to its endpoints
The Partners API exposes one set of endpoints per resource. Every resource follows the same REST contract, so once you know one, you know them all.
The shared contract
For a resource at /{resource}, the endpoints are:
| Operation | Method | Path |
|---|---|---|
| List | GET | /partners/{version}/{tenant}/{resource} |
| Get one | GET | /partners/{version}/{tenant}/{resource}/{id} |
| Create | POST | /partners/{version}/{tenant}/{resource} |
| Update | PATCH | /partners/{version}/{tenant}/{resource}/{id} |
| Delete | DELETE | /partners/{version}/{tenant}/{resource}/{id} |
Reads are scoped to the tenant in the path; writes attach the tenant automatically and only ever affect your own tenant's records. If your tenant is in a tenant group, reads of shared resources also return the group's records. See Authentication and Multi-tenancy for the request basics, and Query parameters for filtering, pagination, and field selection.
Resources
| Resource | Path | Endpoints |
|---|---|---|
| Pages | /pages | Pages |
| Events | /events | Events |
| Event instances | /event-instances | Event instances |
| Posts | /posts | Posts |
| Blogs | /blogs | Blogs |
| People | /people | People |
| Venues | /venues | Venues |
| Organizations | /organizations | Organizations |
| Seasons | /seasons | Seasons |
| Series | /series | Series |
| Works | /works | Works |
| Media | /media | Media |
| Files | /files | Files |
| Forms | /forms | Forms |
| Redirects | /redirects | Redirects |
| Custom attributes | /custom-attributes | Custom attributes |
| Custom object definitions | /custom-object-definitions | Custom object definitions |
| Custom object instances | /custom-object-instances | Custom object instances |