{ success: true, data: ... }. Lists add a meta object with pagination.{ success: false, error: { code, message } }.page (1-based) and limit./api/auth/*./api/account/avatarPOST /api/account/avatar — multipart form with a single `file`.
/api/account/passwordPOST /api/account/password — give an account its first password.
newPassword/api/admin/accounts/api/admin/accounts/{id}GET /api/admin/accounts/:id — one gallery, in full.
id/api/admin/accounts/{id}/compPOST /api/admin/accounts/:id/comp — give a gallery their account for free.
idprice_idreason/api/admin/accounts/{id}/creditPOST /api/admin/accounts/:id/credit — put credit on a gallery's account.
idamountdirectionreason/api/admin/accounts/{id}/compDELETE /api/admin/accounts/:id/comp — make the account billable again.
id/api/artistslimitpagesearchsortBysortOrder/api/artists/{id}id/api/artists/{id}/imagesid/api/artists/api/artists/{id}/imagesid/api/artists/bulk-deleteartistIds/api/artists/importartistimages/api/artists/{id}id/api/artists/{id}/images/{imageId}idimageIdis_primaryorder/api/artists/{id}/images/{imageId}/captionidimageIdcaption/api/artists/{id}/images/{imageId}/primaryidimageId/api/artists/{id}id/api/artists/{id}/images/{imageId}idimageId/api/artworksarchivedartist_idgrouplimitlocation_idpagesearchstatus/api/artworks/{id}id/api/artworks/{id}/appraisalsGET /api/artworks/:id/appraisals — the valuation history, newest first.
id/api/artworks/{id}/conditionGET /api/artworks/:id/condition — the inspection history, newest first.
id/api/artworks/{id}/editionGET /api/artworks/:id/edition — the run this work belongs to, or null.
id/api/artworks/{id}/imagesid/api/artworks/{id}/provenanceGET /api/artworks/:id/provenance — the ownership chain, earliest first.
id/api/artworks/{id}/quick-viewGET /api/artworks/:id/quick-view — everything the artwork popover shows.
id/api/artworks/{id}/viewsiddays/api/artworks/api/artworks/{id}/appraisalsPOST /api/artworks/:id/appraisals — record a valuation.
idappraisercurrencyeffective_atexpires_atnotespurposereferencevalue/api/artworks/{id}/conditionPOST /api/artworks/:id/condition — record an inspection.
idcontextinspected_atnotesratingsummary/api/artworks/{id}/condition/{reportId}POST /api/artworks/:id/condition/:reportId — attach a photograph.
idreportId/api/artworks/{id}/holdPOST /api/artworks/:id/hold — take a work off the market for a collector.
idcustomer_iduntil/api/artworks/{id}/imagesid/api/artworks/{id}/provenancePOST /api/artworks/:id/provenance — add a link to the chain.
iddetailfrom_yearis_currentownerto_year/api/artworks/bulk-archiveArchive or restore artworks in bulk.
archivedartworkIds/api/artworks/bulk-deleteartworkIds/api/artworks/importartist_external_refartworkimagesnote/api/artworks/{id}id/api/artworks/{id}/provenancePUT /api/artworks/:id/provenance — reorder the chain.
idorder/api/artworks/{id}/images/{imageId}/captionidimageIdcaption/api/artworks/{id}/images/{imageId}/primaryidimageId/api/artworks/{id}/provenance/{entryId}identryIddetailfrom_yearis_currentownerto_year/api/artworks/{id}id/api/artworks/{id}/appraisals/{appraisalId}DELETE /api/artworks/:id/appraisals/:appraisalId
idappraisalId/api/artworks/{id}/condition/{reportId}DELETE /api/artworks/:id/condition/:reportId
idreportId/api/artworks/{id}/holdDELETE /api/artworks/:id/hold — put it back on the market.
id/api/artworks/{id}/images/{imageId}idimageId/api/artworks/{id}/provenance/{entryId}identryId/api/auditHistory for one record, newest first.
entity_identity_typelimitoffset/api/auth/*/api/auth/*/api/billingGET /api/billing — everything the billing page renders, in one call.
/api/billing/invoicesGET /api/billing/invoices — the gallery's invoice history.
limit/api/billing/plansGET /api/billing/plans — the published tiers.
/api/billing/cancelPOST /api/billing/cancel — stop the subscription renewing.
/api/billing/change-planPOST /api/billing/change-plan — move to a different tier.
price_id/api/billing/checkoutPOST /api/billing/checkout — start a subscription.
price_idtheme/api/billing/payment-methodPOST /api/billing/payment-method — a SetupIntent for adding a card.
/api/billing/previewPOST /api/billing/preview — what changing plan costs today.
price_id/api/billing/promoPOST /api/billing/promo — apply a discount code.
code/api/billing/resumePOST /api/billing/resume — undo a scheduled cancellation.
/api/billing/payment-methodPATCH /api/billing/payment-method — make a card the default.
payment_method_id/api/billing/cancel/api/billing/payment-methodDELETE /api/billing/payment-method — remove a card.
/api/billing/promoDELETE /api/billing/promo — take the discount back off.
/api/blog/categories/api/blog/postsauthor_idcategory_idlimitpagesearchstatustag_id/api/blog/posts/{id}id/api/blog/tags/api/blog/categoriescolordescriptionnameslug/api/blog/importpostupdate_existing/api/blog/postsallow_commentscategory_idscontentexcerptfeatured_imagefeatured_image_altpublished_atscheduled_forseo_descriptionseo_keywordsseo_titleslugstatustag_idstitle/api/blog/tagsnameslug/api/blog/uploadPOST /api/blog/upload — multipart form with a single `file`.
/api/blog/posts/{id}idallow_commentscategory_idscontentexcerptfeatured_imagefeatured_image_altpublished_atscheduled_forseo_descriptionseo_keywordsseo_titleslugstatustag_idstitle/api/blog/posts/{id}id/api/categorieslimitpagesearch/api/categories/{id}id/api/categoriesnameslug/api/categories/{id}id/api/categories/{id}id/api/consignmentsGET /api/consignments — agreements covering work in someone else's hands, or someone else's work in the gallery's.
artwork_iddirectionlimitoverduepagesearchstatustype/api/consignments/{id}id/api/consignmentsPOST /api/consignments — raise an agreement, optionally with its works.
artist_idcommission_ratecounterparty_namecustomer_iddirectiondue_dateitemslocation_idnotesstart_datestatustermstype/api/consignments/{id}/itemsPOST /api/consignments/:id/items — add works to an existing agreement.
idagreed_priceartwork_idcommission_ratecurrencyitemsnotes/api/consignments/{id}idartist_idcommission_ratecounterparty_namecustomer_iddue_datelocation_idnotesstart_datestatustermstype/api/consignments/{id}/items/{itemId}PATCH /api/consignments/:id/items/:itemId
iditemIdagreed_pricecommission_ratecurrencynotesstatus/api/consignments/{id}DELETE /api/consignments/:id
id/api/consignments/{id}/items/{itemId}DELETE /api/consignments/:id/items/:itemId — take a work off an agreement.
iditemId/api/customerslimitpagesearch/api/customers/{id}id/api/customers/api/customers/importcustomerupdate_existing/api/customers/{id}id/api/customers/{id}id/api/dashboardAggregated numbers behind /dashboard. It exists so the overview loads from a single round trip instead of fanning out to every list endpoint and summing on the client — which would also only ever see the first page of each list.
/api/dealsGET /api/deals — the pipeline.
customer_idopensearchstage/api/deals/{id}id/api/dealsPOST /api/deals — start working a sale.
artwork_idscurrencycustomer_idexpected_closeinquiry_idnotesstagevalueviewing_room_id/api/deals/{id}/offersPOST /api/deals/:id/offers — put a price to the collector.
idamountcurrencyexpires_atmessagenotessend/api/deals/{id}idartwork_idscurrencyexpected_closelost_reasonnotesstagevalue/api/deals/{id}id/api/docs/{slug}slug/api/editionsGET /api/editions — every run the gallery holds.
limitpage/api/editions/{id}id/api/editionsPOST /api/editions — turn a work into a run.
artist_proofsartwork_idhors_commercenotesprinter_proofssize/api/editions/{id}idnotessize/api/editions/{id}DELETE /api/editions/:id — dissolve the run.
id/api/entitlementsGET /api/entitlements — what this gallery may currently do.
/api/eventslimitlocation_idpagesearchstatus/api/events/{id}id/api/events/{id}/rsvpsGET /api/events/:id/rsvps — the guest list. Pass ?format=csv to download it instead of paging through it.
idformatlimitpage/api/events/api/events/{id}/rsvpsPOST /api/events/:id/rsvps — add a guest by hand, for the ones who phone in. Public submissions come through the public gallery endpoint instead.
idcommentsemailnameparty_sizesource/api/events/importeventupdate_existing/api/events/uploadPOST /api/events/upload — multipart form with a single `file`.
/api/events/{id}id/api/events/{id}id/api/events/{id}/rsvps/{rsvpId}DELETE /api/events/:id/rsvps/:rsvpId — drop a cancellation or a spam entry.
idrsvpId/api/exhibitionsartist_idlimitlocation_idpagesearch/api/exhibitions/{id}id/api/exhibitions/api/exhibitions/{id}id/api/exhibitions/{id}id/api/health/api/inquirieslimitpagesearchstatus/api/inquiriesartwork_idcustomercustomer_idemailfirst_namelast_namemessagephonesource/api/invitations/{id}Public read of a single invitation.
id/api/locationslimitpagesearch/api/locations/{id}id/api/locationsaddresscitycommission_ratecountrydescriptionfacebookgallery_nameinstagramphonepostal_codestatetax_idtwitterwebsite/api/locations/{id}id/api/locations/{id}Delete a location.
idreassign_to/api/metadata-keystype/api/notesGET /api/notes?target_type=artwork&target_id=<id>
target_idtarget_type/api/notesPOST /api/notes
contenttarget_idtarget_type/api/notes/{id}PUT /api/notes/:id { content }
idcontent/api/notes/{id}DELETE /api/notes/:id
id/api/notifications/preferencesThe signed-in member's notification settings for their active organization.
/api/notifications/preferencesUpdate one preference for the signed-in member.
enabledtype/api/offers/{id}PATCH /api/offers/:id — move an offer along.
idactionamountcurrencyexpires_atmessagenotes/api/offers/{id}DELETE /api/offers/:id — remove a draft that was never sent.
id/api/orderslimitpagesearchstatus/api/orders/{id}id/api/orders/{id}/paymentsGET /api/orders/:id/payments — every payment against an order.
id/api/orders/api/orders/{id}/issuePOST /api/orders/:id/issue — finalise a draft without sending it anywhere.
id/api/orders/{id}/payment-linkPOST /api/orders/:id/payment-link — mint the collector's payment page.
id/api/orders/{id}/paymentsPOST /api/orders/:id/payments — apply a payment to an order.
id/api/orders/{id}/sendPOST /api/orders/:id/send — finalise a draft and email the collector.
id/api/orders/{id}id/api/orders/{id}id/api/orders/{id}/payment-linkDELETE /api/orders/:id/payment-link — revoke the link.
id/api/orders/{id}/payments/{paymentId}DELETE /api/orders/:id/payments/:paymentId — remove a payment.
idpaymentId/api/organizations/api/organizations/current/api/organizations/createnameslug/api/organizations/purgePermanently destroys an organization: its storage objects, then every row that hangs off it, then the organization itself.
confirmation/api/organizations/setorganizationId/api/organizations/currentlogonameslug/api/payoutsGET /api/payouts — statements raised for artists.
artist_idlimitpagesearchstatus/api/payouts/{id}id/api/payouts/unsettledGET /api/payouts/unsettled — what is owed but not yet settled.
artist_idfromto/api/payoutsPOST /api/payouts — raise a statement from an artist's unsettled sales.
adjustment_noteadjustmentsartist_idnotesorder_item_idsperiod_endperiod_start/api/payouts/{id}idadjustment_noteadjustmentsnotespayment_methodpayment_referenceperiod_endperiod_startstatus/api/payouts/{id}DELETE /api/payouts/:id
id/api/print/artworksconsignmentexhibitionidsroom/api/print/invoiceGET /api/print/invoice?order=<id> — the billing document for a sale.
order/api/profiles/artist/api/profiles/gallery/api/profiles/artistaddressartist_statementbiocitycountryfacebookinstagramphonepostal_codestatetwitterwebsite/api/profiles/galleryaddresscitycommission_ratecountrydescriptionfacebookgallery_nameinstagramphonepostal_codestatetax_idtwitterwebsite/api/profiles/artistaddressartist_statementbiocitycountryfacebookinstagramphonepostal_codestatetwitterwebsite/api/profiles/gallery/api/public/galleries/{site}GET /api/public/galleries/:site — the public face of one site.
site/api/public/galleries/{site}/artistsGET /api/public/galleries/:site/artists — the artists this site shows.
site/api/public/galleries/{site}/artists/{artistId}GET /api/public/galleries/:site/artists/:artistId — one artist, and the work of theirs this site carries.
siteartistId/api/public/galleries/{site}/artwork-statusGET /api/public/galleries/:site/artwork-status?ids=… — what has changed.
site/api/public/galleries/{site}/artworkssite/api/public/galleries/{site}/artworks/{artworkId}GET /api/public/galleries/:site/artworks/:artworkId
siteartworkId/api/public/galleries/{site}/blogGET /api/public/galleries/:site/blog — the site's journal.
site/api/public/galleries/{site}/blog/{slug}GET /api/public/galleries/:site/blog/:slug — one journal post, in full.
siteslug/api/public/galleries/{site}/categoriesGET /api/public/galleries/:site/categories — the facets worth offering.
site/api/public/galleries/{site}/eventsGET /api/public/galleries/:site/events — the public calendar.
site/api/public/galleries/{site}/exhibitionsGET /api/public/galleries/:site/exhibitions — the site's programme.
site/api/public/galleries/{site}/exhibitions/{exhibitionId}GET /api/public/galleries/:site/exhibitions/:exhibitionId — one show and its checklist, narrowed to what this site publishes.
siteexhibitionId/api/public/orders/{token}GET /api/public/orders/:token — what the collector sees before paying.
token/api/public/rooms/{token}GET /api/public/rooms/:token — the room behind a link.
tokenpasscode/api/public/sites/resolveGET /api/public/sites/resolve?host=… — which site answers to this hostname.
host/api/public/galleries/{site}/artworks/{artworkId}/inquiriessiteartworkIdemailfirst_namelast_namemessagephonesource/api/public/galleries/{site}/events/{eventId}/rsvpsPOST /api/public/galleries/:site/events/:eventId/rsvps
siteeventIdcommentsemailnameparty_sizesource/api/public/orders/{token}/checkoutPOST /api/public/orders/:token/checkout — start a card payment.
token/api/public/rooms/{token}/eventsPOST /api/public/rooms/:token/events — what the collector did.
token/api/public/rooms/{token}/inquiriesPOST /api/public/rooms/:token/inquiries — "tell me more about this one".
tokenartwork_idemailmessagenamephone/api/reports/analyticsGET /api/reports/analytics — engagement across viewing rooms.
format/api/reports/insuranceformat/api/reports/inventoryGET /api/reports/inventory — what the gallery holds, what it is worth, and what has been sitting too long.
format/api/reports/salesGET /api/reports/sales — revenue, what sold, and who bought it.
format/api/roomsGET /api/rooms — the gallery's viewing rooms.
limitpagesearchstatus/api/rooms/{id}id/api/rooms/{id}/activityGET /api/rooms/:id/activity — what the room produced.
idrecipient_id/api/rooms/{id}/recipientsGET /api/rooms/:id/recipients — who was sent this room, and what came back.
id/api/roomsPOST /api/rooms — make a room.
/api/rooms/{id}/recipientsPOST /api/rooms/:id/recipients — give one person their own way in.
id/api/rooms/{id}/artworksPUT /api/rooms/:id/artworks — set the checklist.
id/api/rooms/{id}id/api/rooms/{id}/recipients/{recipientId}PATCH /api/rooms/:id/recipients/:recipientId
idrecipientIdexpires_atprivate_notereissuerevokedsend/api/rooms/{id}DELETE /api/rooms/:id
id/api/rooms/{id}/recipients/{recipientId}DELETE /api/rooms/:id/recipients/:recipientId
idrecipientId/api/settings/paymentsGET /api/settings/payments — whether this gallery can take card payments.
/api/settings/websiteGET /api/settings/website — the gallery's public site configuration.
/api/settings/paymentsPOST /api/settings/payments — start or resume Stripe onboarding.
/api/settings/website/upload/{type}POST /api/settings/website/upload/:type — logo, favicon or hero image.
type/api/settings/websitePUT /api/settings/website — save the configuration.
about_textcontact_emaildomainenable_blogenable_eventsenable_shopfacebookfaviconhero_imagehero_subtitlehero_titleinstagramlogoprimary_colorsecondary_colorseo_descriptionseo_keywordsseo_titletwitter/api/settings/paymentsDELETE /api/settings/payments — stop taking payments through this gallery's account.
/api/team/invitations/api/team/members/api/team/invitations/{id}/resendid/api/team/inviteemailrole/api/team/members/{id}idrolestatus/api/team/invitations/{id}id/api/team/members/{id}id/api/users/me/api/users/meemailimagename/api/users/me/api/webhooks/stripePOST /api/webhooks/stripe — Stripe telling us what actually happened.
/api/websitesGET /api/websites — every public site the gallery runs.
/api/websites/{id}id/api/websites/{id}/builder/conversationGET /api/websites/:id/builder/conversation — everything said about this site.
id/api/websites/{id}/builder/elementGET /api/websites/:id/builder/element?loc=… — what this element really is.
idloc/api/websites/{id}/builder/filesGET /api/websites/:id/builder/files — the tree, or one file's contents.
id/api/websites/{id}/builder/historyGET /api/websites/:id/builder/history — every version, and where things stand.
id/api/websites/{id}/builder/previewGET /api/websites/:id/builder/preview — where this site's draft is, and whether there is one yet.
id/api/websites/{id}/domainGET /api/websites/:id/domain — where the domain stands.
id/api/websitesPOST /api/websites — add another site.
is_publishednameselection_mode/api/websites/{id}/builder/chatPOST /api/websites/:id/builder/chat — say something to the builder.
idimageskindmessagepathprovider/api/websites/{id}/builder/elementPOST /api/websites/:id/builder/element — change one element.
idaddattributeslocremovetext/api/websites/{id}/builder/filesPOST /api/websites/:id/builder/files — a new file, and any folders it needs.
idcontentspath/api/websites/{id}/builder/uploadPOST /api/websites/:id/builder/upload — an image for the conversation.
id/api/websites/{id}/builder/versionPOST /api/websites/:id/builder/version — move through the history.
idactionversion/api/websites/{id}/upload/{type}POST /api/websites/:id/upload/:type — logo, favicon or hero image.
idtype/api/websites/{id}idabout_textartist_idsartwork_idscategory_idscontact_emaildomainenable_blogenable_eventsenable_shopfacebookfaviconhero_imagehero_subtitlehero_titleinstagramis_primaryis_publishedlogonameprimary_colorsecondary_colorselection_modeseo_descriptionseo_keywordsseo_titletwitter/api/websites/{id}/builder/filesPUT /api/websites/:id/builder/files — save one file.
idcontentspath/api/websites/{id}/domainPUT /api/websites/:id/domain — attach a gallery's own domain.
iddomaindomain_checkdomain_checked_atdomain_statusdomain_verified_aterrorsuccess/api/websites/{id}/builder/filesPATCH /api/websites/:id/builder/files — rename, which is also how a file moves.
idfromto/api/websites/{id}DELETE /api/websites/:id
id/api/websites/{id}/builder/conversationDELETE /api/websites/:id/builder/conversation — start a fresh conversation.
id/api/websites/{id}/builder/filesDELETE /api/websites/:id/builder/files?path=… — remove one file.
idpath/api/websites/{id}/domainDELETE /api/websites/:id/domain — go back to the default address.
id