Apostille Finder API
The read API is free, needs no key and reads only. The admin routes under /admin/ need an admin session. Every read response carries meta.attribution and…
Government & public#government
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The read API is free, needs no key and reads only. The admin routes under /admin/ need an admin session. Every read response carries meta.attribution and meta.sources.
Endpoints 274
- GETSearch and list listings
/listings - GETRead one listing
/listings/:slug - GETList countries, regions and cities with counts
/places - GETList the category tree with counts
/categories - GETList the data sources with license and refresh
/sources - GETCounts and the last update
/stats - GETList the live products, all or one category's
/products - GETRead one product
/products/:slug - GETList the product categories with their product counts
/product-categories - GETList the published academy courses
/academy/courses - GETRead one published course with its objectives, lessons and FAQ. No exam questions or answers
/academy/courses/:slug - GETVerify one certificate of completion by its code
/certificates/:code - POSTStart a one-time sponsorship Checkout for a tier and a target (a published listing, or a brand name and website). The client sends ids and choices, never an amount. 404: no such listing. 409: the Stripe Price is not ready. 503: billing is not configured.
/sponsor/checkout - POSTSave what to show for a paid sponsorship: the name, website, one line of text, an optional logo URL and, for the sponsored package only, the public path of the page for the slot (a real city, region, category or city category page, as the package scope says). The Checkout Session id is the capability. One save only. 400: a bad field, a placement that is not a real page, a placement missing for the sponsored package or given for another package. 404: no paid sponsorship for that Session. 409: already saved, or the sponsorship is not active.
/sponsor/intake - POSTLint ad copy or prepare a dry-run format plan. Stores nothing and sends nothing. Session only.
/admin/ad-engine - GETList social news entries and revisions. News must be configured. Needs news:read or an admin session.
/admin/social - POSTIngest at most ten social news entries. Existing revision and approval checks apply. Needs news:write or an admin session.
/admin/social - GETRead the news pause and writer alert state. Needs news:read or an admin session.
/admin/social/control - POSTChange one pause or writer alert value. Existing operator restrictions apply. Needs news:write or an admin session.
/admin/social/control - POSTApply a revision-checked news delivery transition. Existing claim and operator restrictions apply. Needs news:write or an admin session.
/admin/social/delivery - GETExport directory submissions as CSV. Session admin only. An unknown status filter is ignored.
/admin/backlinks/export - POSTSend one confirmed test call, text or postcard. Needs the leads:write scope or an admin session.
/admin/test-sends - POSTPreview a fixed spoken line with the selected voice. Session admin only. Success returns raw audio bytes.
/admin/voice/preview - GETThe agent runs, newest first, filtered by status and agent. Pass the cursor of the page before to read on. Needs the agent:run scope or an admin session.
/admin/agent-runs - POSTRecord one agent run: agent, command, input, status, output link, error and retry flag. A run that is not running has finished now. Needs the agent:run scope or an admin session.
/admin/agent-runs - PATCHFinish a running agent run with its outcome: succeeded, failed or cancelled, with the output link, the error and the retry flag. A run that has finished is a 409. Needs the agent:run scope or an admin session.
/admin/agent-runs/:id - PUTCreate or replace one app. Needs the apps:write scope or an admin session.
/admin/apps/:slug - DELETEDelete one app. Needs the apps:write scope or an admin session.
/admin/apps/:slug - GETThe audit log, newest first.
/admin/audit-log - POSTSnapshot the site database into private storage and record the run. Takes no request body.
/admin/backup/export - GETNeeds the backups:read scope or an admin session. The backup ledger and the last export.
/admin/backup/status - PUTCreate or replace one category. Needs the categories:write scope or an admin session.
/admin/categories/:slug - DELETEDelete one category that has no children and no listings. Needs the categories:write scope or an admin session.
/admin/categories/:slug - GETThe subscriptions of this site, newest first, with the failed-payment state: when the failure began and when the grace period ends. Reads the local table. Needs the billing:read scope or an admin session.
/admin/billing/subscriptions - GETThe sponsorships of this site, newest first, with what the buyer sent after paying (the intake). Reads the local table. Needs the billing:read scope or an admin session.
/admin/sponsorships - PATCHPreview cancellation by default. Apply with dryRun false and confirm equal to the subscription id; then cancel at Stripe now or at the end of the paid period and sync it. Needs the billing:write scope or an admin session.
/admin/billing/subscriptions/:id - GETThe Stripe invoices of one subscription of this site, newest first. Needs the billing:read scope or an admin session.
/admin/billing/invoices?subscription=string - POSTRefund the payment of one subscription invoice of this site, in part or in full. A full refund revokes the tier and cancels the subscription. Needs the billing:write scope or an admin session.
/admin/billing/invoices/:id/refund - POSTRetry the failed renewal of a past_due subscription: pay its newest open invoice now. A declined card answers 200 with paid false. Needs the billing:write scope or an admin session.
/admin/billing/retry - POSTApprove or reject a manual claim.
/admin/claims/:id - DELETEPreview deletion by default. Apply with dryRun false and confirm equal to the claim id. A verified claim that sets the listing's current owner answers 409: revoke the owner first. Needs the submissions:review scope or an admin session.
/admin/claims/:id - POSTAssign the owner of a listing by admin fiat: a verified manual claim, no email flow. An active paid subscription blocks it (409). Needs the submissions:review scope or an admin session.
/admin/listings/:id/owner - DELETERevoke the owner of a listing: its verified claim expires and claimed_by clears. 409 when the listing has no owner. Needs the submissions:review scope or an admin session.
/admin/listings/:id/owner - GETClaims, newest first. Filter by listing (id or slug) and status. Needs the submissions:review scope or an admin session.
/admin/claims - GETList every guide of this site, drafts included. Needs the content:read scope or an admin session.
/admin/guides - POSTCreate or replace one guide from a Markdown file. Needs the content:write scope or an admin session.
/admin/guides - GETRead one guide. Needs the content:read scope or an admin session.
/admin/guides/:slug - PUTReplace one guide from a Markdown file. Needs the content:write scope or an admin session.
/admin/guides/:slug - DELETEDelete one guide. Needs the content:write scope or an admin session.
/admin/guides/:slug - PATCHPublish or unpublish one guide. Needs the content:write scope or an admin session.
/admin/guides/:slug - GETList every free tool of this site in page order. Needs the content:read scope or an admin session.
/admin/tools - POSTCreate one free tool of a template kind (price-per-unit, cost-compare, checklist, budget, glossary-lookup). The params go through the same builder schema as config, so bad params answer 400. Any other kind answers 400: its definition file lives in git. A duplicate slug answers 409. Audited. Needs the content:write scope or an admin session.
/admin/tools - GETRead one free tool. Needs the content:read scope or an admin session.
/admin/tools/:slug - DELETEDelete one free tool of any kind. A seeded tool stays deleted when the seed runs again. Audited. Needs the content:write scope or an admin session.
/admin/tools/:slug - PATCHChange fields of one free tool of any kind. params is accepted for a template kind only and is validated by its builder. Nothing is written when validation fails. Audited. Needs the content:write scope or an admin session.
/admin/tools/:slug - GETThe filtered contacts as CSV.
/admin/crm/export - GETList every paid store body override for this site. Needs the content:read scope or an admin session.
/admin/store-content - POSTCreate or replace one paid store body from a Markdown file. Needs the content:write scope or an admin session.
/admin/store-content - GETRead one paid store body override. Needs the content:read scope or an admin session.
/admin/store-content/:contentSlug - PUTReplace one paid store body from a Markdown file. Needs the content:write scope or an admin session.
/admin/store-content/:contentSlug - DELETEDelete one paid store body override. Needs the content:write scope or an admin session.
/admin/store-content/:contentSlug - PATCHPublish or unpublish one paid store body override. Needs the content:write scope or an admin session.
/admin/store-content/:contentSlug - POSTAdd a note to a contact.
/admin/crm/:id - DELETERemove a contact.
/admin/crm/:id - PATCHEdit a contact's fields.
/admin/crm/:id - POSTAccept, reject or spam a suggestion.
/admin/edits/:id - GETThe enrichment requests of the site, newest first, filtered by status. Pass the cursor of the page before to read on. Needs the content:read scope or an admin session.
/admin/enrichment/requests - PATCHMove one enrichment request on: open to running, then running to done (with listingsDone) or failed (with error). An open request may also fail. Any other step is a 409. Needs the content:write scope or an admin session.
/admin/enrichment/requests/:id - POSTCreate one ad campaign through the ads relay. With dryRun true nothing is written. A live write is audited. Admin session only; 404 when the relay is not set up.
/admin/ads/campaigns - POSTPause or resume one campaign through the ads relay. Audited. Admin session only; 404 when the relay is not set up.
/admin/ads/campaigns/:id/status - POSTAsk for one enrichment run of this site. The request waits for the daily runner on the owner's machine. A site holds one open or running request at a time (409 otherwise). Needs the content:write scope or an admin session.
/admin/enrichment/run - GETThe enrichment import log of the site, newest first. Pass the cursor of the page before to read on. Needs the content:read scope or an admin session.
/admin/enrichment/runs - GETPrivate enrichment observations for one listing or external discovery identity, newest first. Pass the cursor of the page before to read on. Needs the content:read scope or an admin session.
/admin/enrichment/observations - POSTAppend one private enrichment observation with idempotent site/provider/callId/sourceRef keys. Replay returns the existing id; changed facts under the same key are 409. Needs the content:write scope or an admin session.
/admin/enrichment/observations - GETThe forms inbox as CSV.
/admin/forms/export.csv - POSTMark a message (read, spam, not-spam, archive) or send a mail. Audited, without the body. Needs the mail:write scope or an admin session.
/admin/mail - GETThe latest received mail, newest first, with the verification links and codes found in each. Returns no message body. Needs the mail:read scope or an admin session.
/admin/mail/recent - GETSupport tickets, oldest first. One ticket per inbound mail thread. Needs the mail:read scope or an admin session.
/admin/support/tickets - GETThe canned support replies, finished: each text is ready to send. The words come from the site config and the fixed policy sentences. Needs the mail:read scope or an admin session.
/admin/support/canned - POSTRefund the payment of one subscription invoice of this site for a support ticket, in part or in full. It runs the billing refund and adds the ticket id to its audit rows. An open ticket becomes pending. A resolved ticket answers 409. Stripe is in test mode outside production. Needs the billing:write scope or an admin session.
/admin/support/refund - POSTRecord a takedown request and hand it to a human: the named ticket is escalated and the admins are mailed. It only records. No listing changes, no copied data is deleted and nothing is sent to the requester. Audited. Needs the mail:write scope or an admin session.
/admin/support/takedown - POSTRecord a legal request and hand it to a human: the named ticket is escalated and the admins are mailed. It only records. Nothing is changed and nothing is sent to the requester. Audited. Needs the mail:write scope or an admin session.
/admin/support/legal - GETTakedown and legal requests, oldest first. Needs the mail:read scope or an admin session.
/admin/support/requests - PATCHChange one support ticket status (open, pending, resolved). Audited. Needs the mail:write scope or an admin session.
/admin/support/tickets/:id - POSTHand one support ticket to a human, once. Records the reason and mails the admins. Changes no status and sends nothing to the sender. Audited. Needs the mail:write scope or an admin session.
/admin/support/tickets/:id/escalate - POSTAnswer the sender of one support ticket by mail, on the ticket thread, with free text or the id of a canned reply (exactly one). The recipient is the verified envelope sender, never an input. An open ticket becomes pending. A resolved ticket answers 409. Audited without the body. Needs the mail:write scope or an admin session.
/admin/support/tickets/:id/reply - GETDownload one attachment of a stored message.
/admin/mail/:messageId/attachments/:attachmentId - GETNeeds the monitoring:read scope or an admin session. The open alerts in the monitoring feed, newest first. Pass the cursor of the page before to read on.
/admin/monitoring/alerts - GETNeeds the monitoring:read scope or an admin session. The site rollup: identity, the newest event of each kind and the open-alert counts.
/admin/monitoring/sites - GETThe domain, DNS, routing and mailbox state. Needs the domains:manage scope or an admin session.
/admin/domains/:domain/status - POSTRe-read the Cloudflare state and cross-check it against a public resolver, one verdict per check. Audited. Needs the domains:manage scope or an admin session.
/admin/domains/:domain/verify - POSTStart one parallel call run. Needs the leads:write scope or an admin session.
/admin/leads/dispatch - POSTCreate, update or delete a drip sequence: a name plus ordered steps (template, delay in days; 0 sends at enroll time). A step's channel is its template's kind; a mismatch is refused, and a delete is refused while an enrollment is active. Also enroll a lead (dripId, leadId, optional postcardTo snapshot; a second active enrollment is 409) or stop an enrollment (id). Needs the leads:write scope or an admin session.
/admin/leads/drips - POSTSet lead status, request a call, set the script, send a text or a postcard, refresh a transcript, barge in, or reroute (forward a lead with no owner address to the closest listing that has one, once; `visitorNotice` says whether the visitor was told, and an admin run never mails an unconfirmed visitor; with no match it emails the visitor nearby contacts and the site's paid guide, and the reply says what happened in `offer`). Needs the leads:write scope or an admin session.
/admin/leads/:id - POSTCreate or delete a knowledge-base document. Needs the leads:write scope or an admin session.
/admin/leads/kb - GETBilled lead charges plus call spend, per listing.
/admin/leads/reconcile - POSTCreate, update or delete a call script. Needs the leads:write scope or an admin session.
/admin/leads/scripts - POSTCreate, update or delete a message template (text, call or postcard body with {{variables}}). Needs the leads:write scope or an admin session.
/admin/leads/templates - GETThe link exchanges, newest first: the site, the contact, the placement, the last live-link check and the AI screen. Filter by status (pending, approved, rejected, spam, broken). Pass nextCursor as cursor to read on. Needs the submissions:review scope or an admin session.
/admin/link-exchanges - POSTCreate one link exchange as an admin: the same live reciprocal-link check and the same AI screen as the public form, then a pending row. A site URL another row already holds answers 409. Audited. Needs the submissions:review scope or an admin session.
/admin/link-exchanges - GETRead one link exchange whole: the site, the contact, the last live-link check, the AI screen and the review. Needs the submissions:review scope or an admin session.
/admin/link-exchanges/:id - POSTApprove, reject, spam or recheck a link exchange.
/admin/link-exchanges/:id - DELETEPreview deletion by default: the row stays. Apply with dryRun false and confirm equal to the id. Audited. Needs the submissions:review scope or an admin session.
/admin/link-exchanges/:id - PATCHEdit the stored fields of one link exchange. A field left out keeps its value; null clears a nullable field. A changed reciprocal URL is re-checked live before the write lands: an approved row whose link is gone turns broken, a broken row whose link is back turns approved. A site URL another row already holds answers 409. Audited. Needs the submissions:review scope or an admin session.
/admin/link-exchanges/:id - GETList listings of every status (draft, pending, published, archived), ordered by id. Filter by status, category slug and place path. Pass nextCursor as cursor to read on. Needs the listings:read scope or an admin session.
/admin/listings - GETRead one listing of any status by id or slug: every field, attributes, categories (primary first), and its photo and review counts. Needs the listings:read scope or an admin session.
/admin/listings/:slug - PUTCreate or replace one listing at its slug. The importer checks it as it checks `bun run import`. Omitted status and omitted or empty categories keep their stored values. Existing source identity is fixed. A different non-empty source_ref returns 400; omitted, null or empty values retain both source fields. Create a new listing to use a different identity. New listings accept source_ref; a configured prefix selects a source. Omitted source_url resets to the configured URL. Other omitted fields use defaults. Tier is never set here. Public pages show edits within about 10 minutes. Needs the listings:write scope or an admin session.
/admin/listings/:slug - POSTFeature, unfeature or mark a listing real, by listing id.
/admin/listings/:slug - DELETEPreview deletion by default, with per-table row counts in the plan. Apply with body dryRun false and confirm equal to the listing id. An owner, an open claim, an open checkout, a live or incomplete subscription, a held or active booking, or a waitlist entry returns 409. Failed object cleanup returns orphanedObjects and retries through the upload cron. Stripe is never called. Needs listings:write or an admin session.
/admin/listings/:slug - PATCHChange some fields of one listing, by id or slug: editable import fields, categories (the first is primary), attributes, status and place. A field not named keeps its value; null clears nullable fields. Source identity is read-only; currency, language and source_url reject null. Set status archived to take a listing down and keep it. Public pages show edits within about 10 minutes. Needs the listings:write scope or an admin session.
/admin/listings/:slug - POSTValidate up to 100 listing rows and return the plan with field diffs (dryRun, the default), or apply it in one batch. Needs the listings:write scope or an admin session.
/admin/listings/bulk - GETUploaded photos of a listing, in display order. Needs the content:read scope or an admin session.
/admin/listings/:slug/photos - POSTAdd an upload to a listing: a multipart body with a file field (and alt), or JSON with an https url the server fetches. JPEG, PNG or WebP only; the size and pixel limits of owner uploads apply. Needs the listings:write scope or an admin session.
/admin/listings/:slug/photos - PATCHPut the photos in a new order in one call. Name every uploaded photo of the listing. Needs the listings:write scope or an admin session.
/admin/listings/:slug/photos - DELETEDelete one uploaded photo and its R2 object. Failed object deletions remain queued for retry. Needs the listings:write scope or an admin session.
/admin/listings/:slug/photos/:photoId - PATCHChange the alt text or the sort order of one photo. Needs the listings:write scope or an admin session.
/admin/listings/:slug/photos/:photoId - GETThe glossary terms in page order (position, then id), at most 100 a page. Pass the nextCursor of the page before as cursor to read on. Needs the content:read scope or an admin session.
/admin/glossary - POSTAdd one glossary term: term up to 200 characters, definition up to 10,000. At most 500 terms (409). A position left out puts it last. A slug left out comes from the term; a slug another term has is a 409. The public page shows it at once. Audited. Needs the content:write scope or an admin session.
/admin/glossary - POSTReorder glossary terms: the named rows take the positions they held, sorted, in the order given. Rows not named keep theirs. Audited. Needs the content:write scope or an admin session.
/admin/glossary/reorder - GETRead one glossary term. Needs the content:read scope or an admin session.
/admin/glossary/:id - DELETEDelete one glossary term. A deploy never refills an emptied table. Audited. Needs the content:write scope or an admin session.
/admin/glossary/:id - PATCHEdit the named fields of one glossary term, its position included. A slug another term has is a 409. Audited. Needs the content:write scope or an admin session.
/admin/glossary/:id - GETThe FAQ entries in page order (position, then id), at most 100 a page. Pass the nextCursor of the page before as cursor to read on. Needs the content:read scope or an admin session.
/admin/faq - POSTAdd one FAQ entry: question up to 500 characters, answer up to 10,000. At most 500 entries (409). A position left out puts it last. The public page shows it at once. Audited. Needs the content:write scope or an admin session.
/admin/faq - POSTReorder FAQ entries: the named rows take the positions they held, sorted, in the order given. Rows not named keep theirs. Audited. Needs the content:write scope or an admin session.
/admin/faq/reorder - GETRead one FAQ entry. Needs the content:read scope or an admin session.
/admin/faq/:id - DELETEDelete one FAQ entry. A deploy never refills an emptied table. Audited. Needs the content:write scope or an admin session.
/admin/faq/:id - PATCHEdit the named fields of one FAQ entry, its position included. Audited. Needs the content:write scope or an admin session.
/admin/faq/:id - GETThe on-site reviews of one listing, up to 50 ordered by status, every status, with the listing's rating aggregate (the average and count of its published reviews). Needs the listings:write scope or an admin session.
/admin/reviews?slug=string - POSTAdd one on-site review to a listing. status defaults to pending; send status published to show it at once. The answer carries the fresh rating aggregate. Needs the listings:write scope or an admin session.
/admin/reviews?slug=string - GETRead one on-site review of a listing, with the listing's rating aggregate. Needs the listings:write scope or an admin session.
/admin/reviews/:rowId?slug=string - DELETEDelete one on-site review. Preview by default; apply with dryRun false and confirm equal to the review id. The answer carries the fresh rating aggregate. Needs the listings:write scope or an admin session.
/admin/reviews/:rowId?slug=string - PATCHEdit the author name, rating or body of one on-site review. The answer carries the fresh rating aggregate. Needs the listings:write scope or an admin session.
/admin/reviews/:rowId?slug=string - POSTPublish one on-site review: it counts in the listing's rating aggregate at once. A published review answers 409. Needs the listings:write scope or an admin session.
/admin/reviews/:rowId/publish?slug=string - POSTReject one on-site review: it leaves the listing's rating aggregate at once. The reason is kept in the audit row only. A rejected review answers 409. Needs the listings:write scope or an admin session.
/admin/reviews/:rowId/reject?slug=string - GETList source photos in display order, including hidden rows. Needs content:read or an admin session.
/admin/listings/:slug/source-photos - PATCHReorder all source photos, including hidden rows. Name every id exactly once. Dry run by default; set dryRun false to apply. Needs listings:write or an admin session.
/admin/listings/:slug/source-photos - GETRead one source photo on this listing. Needs content:read or an admin session.
/admin/listings/:slug/source-photos/:rowId - DELETESuppress a source photo and retain its identity. Dry run by default. Apply with dryRun false and confirm equal to rowId. Imports cannot restore it. Needs listings:write or an admin session.
/admin/listings/:slug/source-photos/:rowId - PATCHEdit source photo alt text. Dry run by default; set dryRun false to apply. Imports never replace stored photos. Needs listings:write or an admin session.
/admin/listings/:slug/source-photos/:rowId - GETThe menu items of one listing in menu order: section, then sort, then name. Each row says whether the API owns it (adminOwned; an import never deletes or overwrites an admin row). Needs the listings:read scope or an admin session.
/admin/listings/:slug/menu-items - PUTReplace the whole menu set of one listing. items is the full list in menu order; an omitted sort takes the position in items; an empty list clears the menu. Every row the write leaves carries the source tag admin, so an import never deletes or overwrites it. Two items may not share one section and name. Needs the listings:write scope or an admin session.
/admin/listings/:slug/menu-items - POSTAdd one dish to a listing, at the end of its section unless sort names a place. The row carries the source tag admin, so an import never deletes or overwrites it. A section and name the listing already serves is a 409. Needs the listings:write scope or an admin session.
/admin/listings/:slug/menu-items - GETOne menu item of one listing. Needs the listings:read scope or an admin session.
/admin/listings/:slug/menu-items/:rowId - DELETEPreview deletion by default. Apply with body dryRun false and confirm equal to the item id. The row is removed; a later import can still re-add its own dishes, but never an admin row. Needs the listings:write scope or an admin session.
/admin/listings/:slug/menu-items/:rowId - PATCHChange the named fields of one menu item. Null clears a nullable field. A partial price edit resolves the omitted price field from the stored column inside the update, so a concurrent edit of the other price field survives. The row moves to the API (source tag admin), so an import stops owning it. Renaming onto a served section and name is a 409. Needs the listings:write scope or an admin session.
/admin/listings/:slug/menu-items/:rowId - GETAll copied platform reviews of one listing, hidden ones too. Needs the listings:write scope or an admin session.
/admin/listings/:slug/source-reviews - POSTAdd one platform review to a listing. Dry run unless confirm=true. The row is locked, so an enrichment run never overwrites it. Needs the listings:write scope or an admin session.
/admin/listings/:slug/source-reviews - DELETERemove one review from public pages. Dry run unless confirm=true. Retain its hidden, admin-locked identity so imports cannot re-add it. Needs the listings:write scope or an admin session.
/admin/listings/:slug/source-reviews/:rowId - PATCHEdit or hide one review. Dry run unless confirm=true. A content edit locks the row against enrichment runs. hidden removes it from the page and keeps it in the table, so a run does not add it back. Needs the listings:write scope or an admin session.
/admin/listings/:slug/source-reviews/:rowId - GETAll copied platform ratings of one listing, hidden ones too. Needs the listings:write scope or an admin session.
/admin/listings/:slug/source-ratings - POSTAdd one platform rating to a listing. Dry run unless confirm=true. The row is locked, so an enrichment run never overwrites it. Needs the listings:write scope or an admin session.
/admin/listings/:slug/source-ratings - DELETERemove one rating from public pages. Dry run unless confirm=true. Retain its hidden, admin-locked identity so imports cannot re-add it. Needs the listings:write scope or an admin session.
/admin/listings/:slug/source-ratings/:rowId - PATCHEdit or hide one rating. Dry run unless confirm=true. A content edit locks the row against enrichment runs. hidden removes it from the page and keeps it in the table, so a run does not add it back. Needs the listings:write scope or an admin session.
/admin/listings/:slug/source-ratings/:rowId - GETThe retired listing slugs (listing_redirects), newest first, with the listing each points at and its status. Filter by listing (id or slug). Pass the cursor of the page before to read on. Needs the listings:read scope or an admin session.
/admin/redirects - POSTReserve one retired slug for a listing: the old permalink, the old listing URL and the old markdown copy then redirect permanently to it while it stays published. Refused when a listing holds the slug, the slug is the target's own (a loop), a redirect already holds it, or the target's own slug is itself retired (a chain). Audited. Needs the listings:write scope or an admin session.
/admin/redirects - DELETERemove one redirect by its retired slug. Preview by default; apply with dryRun false and confirm equal to the slug. The old URL answers 404 again. Audited. Needs the listings:write scope or an admin session.
/admin/redirects/:id - GETEvery pending submission, edit suggestion, manual claim, open report and pending link exchange as one list, oldest first. Needs the submissions:review scope or an admin session.
/admin/moderation/queue - PATCHDecide one queue item. The id prefix (sub_, edt_, clm_, rpt_, lnk_) names its type. Needs the submissions:review scope or an admin session.
/admin/moderation/:id - GETThe bans, newest first. An IP ban shows the hash. Needs the submissions:review scope or an admin session.
/admin/moderation/ban - POSTBan an email address, an IP or the sender of a queue item. Needs the submissions:review scope or an admin session.
/admin/moderation/ban - DELETELift one ban by its id. Preview by default; apply with dryRun false and confirm equal to the ban id. Needs the submissions:review scope or an admin session.
/admin/moderation/ban - GETThe newsletter API keys. Needs the newsletter:write scope or an admin session.
/admin/newsletter/api-keys - POSTCreate or revoke a newsletter API key. Audited. The secret returns once, in the create answer. Needs the newsletter:write scope or an admin session.
/admin/newsletter/api-keys - GETA page of subscribers, or the filtered CSV export with format=csv.
/admin/newsletter/contacts - POSTAdd, change or remove one subscriber, mail the confirmation to selected pending subscribers, or import a CSV file of subscribers.
/admin/newsletter/contacts - GETThe campaigns, newest first, without bodies. Filter by status. Needs the newsletter:write scope or an admin session.
/admin/newsletter/campaigns - POSTCreate a campaign draft. Needs the newsletter:write scope or an admin session.
/admin/newsletter/campaigns - GETOne campaign with its body. Needs the newsletter:write scope or an admin session.
/admin/newsletter/campaigns/:id - POSTSchedule, cancel, queue, duplicate or test-send a campaign. Needs the newsletter:write scope or an admin session.
/admin/newsletter/campaigns/:id - DELETEPreview deletion by default. Apply with dryRun false and confirm equal to the campaign id. Only drafts can be deleted. Needs the newsletter:write scope or an admin session.
/admin/newsletter/campaigns/:id - PATCHSave a draft or scheduled campaign body. Needs the newsletter:write scope or an admin session.
/admin/newsletter/campaigns/:id - GETLead counts by status and cost per lead by channel (call, text, postcard) and currency for a period. Needs the reports:read scope or an admin session.
/admin/reports/leads - GETGross, refunded and net revenue per currency for a period, from Stripe events and the store, plus active subscriptions by tier. Needs the reports:read scope or an admin session.
/admin/reports/revenue - GETSearch Console clicks, impressions, CTR and position for a period, with the top pages and queries. With no Search Console token it answers configured:false and no numbers. A Search Console fault answers 502. Needs the reports:read scope or an admin session.
/admin/reports/traffic - GETNeeds the seo:write scope or an admin session. The index audit of the site (robots, sitemap, sample pages) plus the sitemap status Search Console reports.
/admin/seo/audit - POSTPush the listings and guides that changed to IndexNow now. Audited. Production only.
/admin/seo/indexnow - POSTSubmit the sitemap to IndexNow and add it to Search Console. Audited. Production only.
/admin/seo/resubmit-sitemap - GETThe site settings. Session admin only: a value can hold a secret, so no token scope and no tool exposes the read.
/admin/settings - PUTCreate or update one setting. Needs the settings:write scope or an admin session.
/admin/settings - DELETERemove one setting. Preview by default: the answer is the plan. Apply with dryRun false and confirm equal to the key. Removing a key that is not there changes nothing and answers ok. Needs the settings:write scope or an admin session.
/admin/settings - POSTExpire the cached public reads (listings, sources) so the next read sees a write that bypassed the API, such as a CLI import. Audited. Needs the listings:write scope or an admin session.
/admin/revalidate - PUTCreate or replace one import source. Needs the sources:write scope or an admin session.
/admin/sources/:key - DELETEDelete one source that has no listings and no import runs. Needs the sources:write scope or an admin session.
/admin/sources/:key - GETNeeds the submissions:review scope or an admin session. The submission queue, newest first.
/admin/submissions - POSTApprove, reject, spam or merge a submission.
/admin/submissions/:id - GETThe service tokens, with hints and metadata only.
/admin/tokens - POSTIssue a service token. The secret comes back in this response only.
/admin/tokens - DELETERevoke a service token.
/admin/tokens/:id - POSTEdit, approve, cancel or send one outreach email message. Send is refused (409, with a code) unless every rule in docs/ops/outreach.md passes. Session only.
/admin/outreach/messages/:id - POSTRead the mail inbox for replies and bounces that name a sent outreach message. A reply ends the sequence. A bounce suppresses the address and counts against the sender. Session only.
/admin/outreach/reconcile - PUTSet the outreach sender: name, mailbox, postal address, DKIM selector, warm-up start, cap override and pause. Session only.
/admin/outreach/sender - POSTAdd or lift one outreach suppression. An add closes the targets it covers. Session only.
/admin/outreach/suppressions - GETOutreach campaigns over the CRM, newest first, 50 a page (limit up to 100). Filter by status and channel; page with the cursor. Needs the outreach:read scope or an admin session.
/admin/outreach/campaigns - POSTCreate one draft outreach campaign: a name, a channel (call, email, text or postcard), a saved CRM audience (status, tag, source), a body with template variables, an email subject, an optional spend cap and a per-send cost estimate in minor units. An email needs a subject. Nothing is sent. Audited. Needs the outreach:write scope or an admin session.
/admin/outreach/campaigns - GETThe CRM contacts a campaign could reach on one channel, 50 a page, oldest first by created time. Filter by status, tag and source. Each row says whether it is reachable and, if not, why: no_lead, no_phone, bad_phone, opted_out, no_email, suppressed, no_address or duplicate. Needs the outreach:read scope or an admin session.
/admin/outreach/contacts?channel=call - POSTPause, resume, mark replied or complained, draft the one follow-up, or set the time zone of an outreach target. A complaint suppresses the address and pauses the sender. Session only.
/admin/outreach/targets/:id - POSTDraft one contact-form interview message for an invite. Sends nothing. Session only.
/admin/outreach/forms - POSTApprove or cancel one drafted contact-form message. Session only.
/admin/outreach/forms/:id - POSTDraft one interview email message for an invite. Sends nothing. Session only.
/admin/outreach/interviews - GETThe cover image or one submission photo for a story in preview. Session only. Sites with blog off answer 404.
/admin/blog/:slug/images - GETThe operator queue of pending visitor requests, oldest first. Session only. No request data is served by the public read API.
/admin/requests - GETEvery product, hidden ones too, by category, featured, rank. Deleted ones only with include_deleted=1. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/products - POSTCreate or replace one product by slug: an idempotent upsert that also restores a deleted one. The URL must be the plain retailer page. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/products - POSTPlan up to 100 products by slug. dryRun defaults to true; set false to apply atomically. Needs products:write or an admin session.
/admin/products/bulk - GETOne product, deleted or not. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/products/:slug - DELETESoft-delete one product: it leaves the site and keeps its row. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/products/:slug - PATCHChange some fields of one product. The result must pass the full product checks. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/products/:slug - GETEvery product category, hidden ones too. Deleted ones only with include_deleted=1. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/product-categories - POSTCreate or replace one product category by slug: an idempotent upsert that also restores a deleted one. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/product-categories - POSTPlan up to 100 product categories by slug. dryRun defaults to true; set false to apply atomically. Needs products:write or an admin session.
/admin/product-categories/bulk - GETOne product category, deleted or not. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/product-categories/:slug - DELETESoft-delete one product category. Its products leave the site with it and keep their rows. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/product-categories/:slug - PATCHChange some fields of one product category. Needs the products:write scope (or PRODUCTS_ADMIN_TOKEN) or an admin session.
/admin/product-categories/:slug - GETEvery certificate template, the default first. Needs the academy:read scope or an admin session.
/admin/academy/templates - GETOne certificate template. Needs the academy:read scope or an admin session.
/admin/academy/templates/:slug - PUTCreate or replace one certificate template by slug: an idempotent upsert that leaves the default flag alone. Needs the academy:write scope or an admin session.
/admin/academy/templates/:slug - DELETEDelete one certificate template. Courses that used it lose the link; issued certificates keep their own copy of the design. Deleting the default leaves the site without one, and certificates then use the built-in design. Needs the academy:write scope or an admin session.
/admin/academy/templates/:slug - POSTMake one certificate template the default. The old default is cleared in the same write, so there is exactly one; a template that already is the default changes nothing. Needs the academy:write scope or an admin session.
/admin/academy/templates/:slug/default - GETThe lessons of a course by position, then slug. Needs the academy:read scope or an admin session.
/admin/academy/courses/:slug/lessons - GETOne lesson of a course. Needs the academy:read scope or an admin session.
/admin/academy/courses/:slug/lessons/:lesson - PUTCreate or replace one lesson by slug: an idempotent upsert. The slug is unique in the course and may not be a reserved page name such as exam. Positions are not unique: equal ones sort by slug. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/lessons/:lesson - DELETEHard-delete one lesson. Its questions stay and lose their lesson. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/lessons/:lesson - GETThe images of a course, oldest first, with the site path of each. Needs the academy:read scope or an admin session.
/admin/academy/courses/:slug/images - POSTAdd one image to a course. Send a multipart body with a file field, alt and optional caption, or JSON with contentBase64, alt and optional caption. PNG, JPEG or WebP only, within the photo size and pixel limits; alt text is required. The answer carries the item url: put it in a lesson body as . Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/images - DELETEHard-delete one image and its stored file. A lesson that names it shows no image there. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/images/:id - GETThe questions of a course, oldest first, with the correct flag of each option. Needs the academy:read scope or an admin session.
/admin/academy/courses/:slug/questions - POSTCreate one exam question; the answer carries its qst_ id. single and scenario need 2 to 8 options, exactly one correct; multi needs 2 to 8, at least one correct and one incorrect; ordering needs 3 to 8 steps in the right order, each correct; short needs 1 to 10 accepted answers of up to 80 characters, each correct. Option ids are unique. lessonId must be a lesson of the same course. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/questions - GETOne question by qst_ id, with the correct flag of each option. Needs the academy:read scope or an admin session.
/admin/academy/courses/:slug/questions/:id - PUTReplace one question by qst_ id; the same checks as create. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/questions/:id - DELETEHard-delete one question by qst_ id. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/questions/:id - GETCourses by sort order, with lesson and question counts, all and published. Deleted ones only with includeDeleted=1. Needs the academy:read scope or an admin session.
/admin/academy/courses - GETOne live course with its lesson and question counts. Needs the academy:read scope or an admin session.
/admin/academy/courses/:slug - PUTCreate or replace one course by slug: an idempotent upsert. published sets whether it is live; going live needs a published question with a correct option, or the answer is a 409 course_not_ready. A soft-deleted slug is a 409 slug_deleted unless restore is true. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug - DELETESoft-delete one course: the row and its certificates stay. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug - POSTPublish one course. Repeating it changes nothing. A course with no published exam question, or with a published question that has no correct option (or, for a single or scenario question, more than one), an ordering question without 3 to 8 steps, or a short question with no accepted answer, is a 409 course_not_ready whose details list what is missing. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/publish - POSTUnpublish one course. Repeating it changes nothing. Needs the academy:write scope or an admin session.
/admin/academy/courses/:slug/unpublish - GETUsers with an enrollment, a certificate or a membership, the most recently active first, with counts and whether they have access now. Needs the academy:read scope or an admin session.
/admin/academy/students - GETOne student with enrollments, attempt scores and pass flags (never answers), certificates and memberships. Needs the academy:read scope or an admin session.
/admin/academy/students/:userId - GETMembership rows, newest first, with the owner's email. active is decided per row at the request time. Needs the academy:read scope or an admin session.
/admin/academy/memberships - POSTGrant a comp membership to a user. A user with an active membership is a 409 already_member; an unknown user is a 404; endsAt must be in the future. Needs the academy:write scope or an admin session.
/admin/academy/memberships - DELETERevoke a comp membership: the row stays as history and access ends now. A Stripe membership is a 409 stripe_membership (the billing admin owns it); one already revoked is a 409. Needs the academy:write scope or an admin session.
/admin/academy/memberships/:id - GETCertificates, newest first, with the revoke reason. Filter by status (valid, expired or revoked, computed from the dates), course slug and code (full or partial, any spelling; a partial matches the start). Needs the academy:read scope or an admin session.
/admin/academy/certificates - POSTIssue one certificate by hand, with no exam attempt. The admin is the audit actor, and the learner gets the certificate email as for an exam pass. 422 for a bad score or name, an unknown user, or an unknown or unpublished course. 409 already_issued when the learner already holds an unrevoked certificate for the course. Needs the academy:write scope or an admin session.
/admin/academy/certificates - GETOne certificate by code, in any spelling: upper or lower case, with or without dashes. 404 certificate_not_found for an invalid or unknown code. Needs the academy:read scope or an admin session.
/admin/academy/certificates/:code - POSTRevoke one certificate with a reason of 3 to 300 characters. The public lookup then answers revoked at once and never shows the reason. 409 already_revoked. Needs the academy:write scope or an admin session.
/admin/academy/certificates/:code/revoke - POSTClear the revoke of one certificate; it reads valid or expired again by its dates. 409 not_revoked. Needs the academy:write scope or an admin session.
/admin/academy/certificates/:code/reinstate - POSTSet a later expiry (an ISO date in the future, after the current one) or neverExpires: true. 409 revoked_cannot_extend for a revoked certificate; 409 not_an_extension for a date that is not later than the current expiry, and for any date on a certificate that never expires. Needs the academy:write scope or an admin session.
/admin/academy/certificates/:code/extend - PUTCreate or replace one place by its path. Needs the places:write scope or an admin session.
/admin/places - DELETEDelete one place that has no child places and no listings. Needs the places:write scope or an admin session.
/admin/places - GETThe accounts, newest first, with role, admin flag, live session count and owned listing count. Pass nextCursor as cursor until it is null. Needs the users:manage scope or an admin session.
/admin/users - POSTCreate one account without sending mail. The role defaults to member. A repeat of an address, in any letter case, is a 409. Needs the users:manage scope or an admin session.
/admin/users - POSTInvite an address: create the account with the role, or reactivate a deactivated one, and mail the sign-in link (the admin host for an admin). A pending invite is sent again with the new role. An account that has signed in is a 409. Needs the users:manage scope or an admin session.
/admin/users/invite - GETThe live sessions of one account, newest first: id, dates, address and user agent. Never the token. Needs the users:manage scope or an admin session.
/admin/users/:id/sessions - DELETERevoke one session of the account (sessionId) or all of them. A session of another account is a 404. Revoking nothing writes no audit row. Needs the users:manage scope or an admin session.
/admin/users/:id/sessions - DELETEOffboard one account. It is deactivated: its sessions are revoked, its role goes back to member and it cannot sign in. The row stays, with its claimed listings. A repeat changes nothing. An admin session cannot name its own account. Needs the users:manage scope or an admin session.
/admin/users/:id - PATCHSet one account's role. `isAdmin` in the answer is the effective flag: an address on the allowlist stays an admin whatever its role. Needs the users:manage scope or an admin session.
/admin/users/:id - GETThe outbound Webhooks.
/admin/webhooks - POSTRegister one Webhook.
/admin/webhooks - DELETERemove one Webhook.
/admin/webhooks/:id - GETThe social video jobs, newest first. Needs the video:write scope or an admin session.
/admin/video/jobs - POSTCreate a social video draft that waits for the owner. Needs the video:write scope or an admin session.
/admin/video/jobs - PATCHApprove, schedule, cancel or kill a video job. Needs the video:write scope or an admin session.
/admin/video/jobs/:id - GETThe publish queue: due jobs, the kill switch and spend against the caps. Needs the video:write scope or an admin session.
/admin/video/queue - GETThe public questions of the request form and whether a stored override or the site config answers them. Public question text only. Needs the settings:write scope or an admin session.
/admin/request-form - PUTReplace the stored request-form questions: up to 12 text, choice, number or date questions, with category restrictions and a follow-up condition on an earlier choice. The schema must pass. Needs the settings:write scope or an admin session.
/admin/request-form - GETThe voice-agent settings the call path uses, and whether a stored override or the site config answers them. Needs the settings:write scope or an admin session.
/admin/voice - PUTReplace the stored voice-agent settings row; the schema must pass. Needs the settings:write scope or an admin session.
/admin/voice - DELETERemove the stored voice-agent settings so the site config defaults apply again. Preview by default; apply with dryRun false and confirm equal to voice.settings. Needs the settings:write scope or an admin session.
/admin/voice - GETList the interview stories, drafts included, newest first. Needs the content:read scope or an admin session.
/admin/blog - GETRead one interview story: title, excerpt, Markdown body, FAQ, SEO fields, image alt, status and the id of the source submission. The submission itself is not part of it. Needs the content:read scope or an admin session.
/admin/blog/:slug - PATCHEdit the named fields of one interview story. The slug changes only while the story is a draft. An edit of a public story reaches the page at once. 409 slug_locked, slug taken or another write won. Needs the content:write scope or an admin session.
/admin/blog/:slug - POSTPublish one draft story. reviewed must be true: the caller read the story against the submitted answers. 409 when consent is missing or withdrawn, the story has no source, or it is already public. Needs the content:write scope or an admin session.
/admin/blog/:slug/publish - POSTReturn one public story to draft. 409 when it is not public. Needs the content:write scope or an admin session.
/admin/blog/:slug/unpublish
API details
- Base URL
https://apostilles.fyi/api/v1- Authentication
- None declared in the description
- Operations
- 274 operations on 180 pathsGET 104POST 90DELETE 37PATCH 27PUT 16
- Response formats
application/jsonaudio/*image/*text/csv- Description format
- OpenAPI 3.1.0, API version
1 - Links
- OpenAPI document
- Listed from
- Apostilles's published OpenAPI description
How to test the Apostille Finder API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Apostille Finder API collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Search and list listings” (GET /listings), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Apostille Finder API?
The read API is free, needs no key and reads only. The admin routes under /admin/ need an admin session. Every read response carries meta.attribution and… It is listed under Government & public and has 274 endpoints.
Who publishes the Apostille Finder API?
It is listed from Apostilles's public API description (an OpenAPI document), not published by Apostilles on Swastik Codes. Anyone who controls apostilles.fyi can claim the profile by adding a DNS TXT record.
What is the base URL of the Apostille Finder API?
Requests go to https://apostilles.fyi/api/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Apostille Finder API?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Apostille Finder API have?
274 operations on 180 paths (104 GET, 90 POST, 37 DELETE, 27 PATCH, 16 PUT).
Is forking the Apostille Finder API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.