Basker Docs

All resources

Every resource the Partners API exposes, with its REST path and a link to its endpoints

The Partners API exposes a consistent REST contract for its resources, plus schema and configured-field operations on supported collections.

The shared contract

For a resource at /{resource}, the endpoints are:

OperationMethodPath
ListGET/partners/{version}/{tenant}/{resource}
Get oneGET/partners/{version}/{tenant}/{resource}/{id}
CreatePOST/partners/{version}/{tenant}/{resource}
UpdatePATCH/partners/{version}/{tenant}/{resource}/{id}
Update with PUTPUT/partners/{version}/{tenant}/{resource}/{id}
DeleteDELETE/partners/{version}/{tenant}/{resource}/{id}

PATCH and PUT use the same partial-update behavior. Successful updates and deletes return the affected record with status 200; creates return status 201.

Reads are scoped to the tenant in the path or an overriding tenant header. Writes attach the resolved tenant automatically and affect only records it owns. If your tenant is in a tenant group, reads of shared resources can also return other group members' records.

Resources

ResourcePathEndpoints
Pages/pagesPages
Events/eventsEvents
Event instances/event-instancesEvent instances
Posts/postsPosts
Blogs/blogsBlogs
People/peoplePeople
Venues/venuesVenues
Organizations/organizationsOrganizations
Seasons/seasonsSeasons
Series/seriesSeries
Works/worksWorks
Media/mediaMedia
Files/filesFiles
Forms/formsForms
Redirects/redirectsRedirects
Custom attributes/custom-attributesCustom attributes
Custom object definitions/custom-object-definitionsCustom object definitions
Custom object instances/custom-object-instancesCustom object instances

Schema and configured-field operations

Supported resources also expose dedicated operations that do not fit the standard record contract:

CapabilityPath shapeGuide
Discover content-block fieldsGET /{collection}/blocks/schemaDiscover fields
Discover record theme settingsGET /{collection}/theme-settings/schemaDiscover fields
Discover custom attributesGET /{collection}/custom-attributes/schemaDiscover fields
Discover site-wide theme settingsGET /theme/settings/schemaDiscover fields
Mutate one record's blocksPATCH /{collection}/{id}/blocksEdit content blocks
Mutate one record's theme settingsPATCH /{collection}/{id}/theme-settingsEdit content blocks
Bulk-update custom attributesPATCH /{collection}/custom-attributesBulk update configured fields
Bulk-update theme settingsPATCH /{collection}/theme-settingsBulk update configured fields

The collection lists and request schemas differ by capability. Use the linked guides and the generated endpoint page rather than assuming every resource supports every dedicated operation.

On this page