to.co forside

to.co's API

Lad din egen software, f.eks. en hjemmeside, et kassesystem eller et script, læse din virksomhed på to.co og holde den opdateret. Nøgler findes med Pro og Grow.

Få en API-nøgle Ruter

Basis-URL
https://api.to.co/v1/orgs/{host}
Godkendelse
Authorization: Bearer toco_ak_…

Få en API-nøgle

Åbn din virksomhed i my.to.co, vælg API-nøgler og derefter Opret nøgle. Giv den et navn, vælg dens rettigheder og hvornår den udløber (højst et år), og kopier den: den vises én gang, og der gemmes kun en hash af den.

Send nøglen i Authorization-headeren ved hver forespørgsel. En nøgle virker kun for sin egen virksomhed: alle andre adresser svarer ikke fundet. API'en tager kun imod nøgler, aldrig en browsersession.

Eksempel på kald

curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
  -H "Authorization: Bearer toco_ak_…"

Rettigheder og abonnementer

En nøgle kan kun gøre det dens rettigheder tillader, og kun det virksomhedens abonnement omfatter på tidspunktet for hver forespørgsel. Læsning er med Pro og Grow; ændringer er med Grow.

RettighedHvad den gørFra abonnement
company:readYour company details, services and locations.Pro
messages:readMessages from your contact form (not those held as spam).Pro
company:writeReplace your services, and change phone numbers and opening hours.Grow
posts:readThe posts you write on to.co, drafts included.Pro
posts:writeWrite, save, publish, unpublish and delete posts.Grow

Ruter

Alle ruter ligger under basis-URL'en med din virksomheds to.co-adresse i stedet for {host}, f.eks. mybusiness.uk.to.co. Forespørgsler og svar er JSON. Ændringer gennemgår de samme kontroller, den samme historik og genudgivelse som ændringer foretaget i my.to.co og registreres som foretaget af nøglen.

RuteHvad den gørRettighed
GET /v1/orgs/{host}The company record, with its services and locations.company:read
GET /v1/orgs/{host}/servicesThe services, in order.company:read
GET /v1/orgs/{host}/locationsThe locations, with phones and opening hours.company:read
GET /v1/orgs/{host}/messagesContact form messages. Filter with ?status=new|read|replied|archived.messages:read
GET /v1/orgs/{host}/messages/{id}One message.messages:read
PATCH /v1/orgs/{host}Change the company phone numbers: JSON { "phones": … }.company:write
PUT /v1/orgs/{host}/servicesReplace the whole list of services, in order: JSON { "services": [ … ] }.company:write
PATCH /v1/orgs/{host}/locations/{location}Change a location: JSON with any of phones, normal_hours and special_hours. Every value is checked, and the answer carries the checks. The registered office comes from the register and cannot be changed.company:write
GET /v1/orgs/{host}/postsPosts written on to.co, newest change first, a page at a time: ?limit, ?state and ?cursor (next_cursor from the page before).posts:read
GET /v1/orgs/{host}/posts/{id}One post, its body as blocks, with its version as the ETag.posts:read
POST /v1/orgs/{host}/postsA new draft: JSON { "title", "standfirst", "body" }, or the body as text/markdown.posts:write
PATCH /v1/orgs/{host}/posts/{id}Save a post. Send the version you are changing as If-Match; JSON, or the body as text/markdown.posts:write
DELETE /v1/orgs/{host}/posts/{id}Move a post to the bin. The owner can restore it in my.to.co for 30 days.posts:write
POST /v1/orgs/{host}/posts/{id}/publishPublish the If-Match version. It is checked first, as when the owner publishes.posts:write
POST /v1/orgs/{host}/posts/{id}/unpublishTake a post off the page and back to a draft.posts:write

Kreditter og grænser

  • Hver forespørgsel bruger én API-kredit fra den samme månedlige kvote som din egen AI-assistents kald til din virksomheds MCP-server: 5,000 om måneden pr. virksomhed med Pro og 50,000 med Grow. En forespørgsel der fejler, giver sin kredit tilbage. Kreditterne nulstilles den 1. i hver måned (UTC), og der er ingen gebyrer for overforbrug. Svarene indeholder X-Credits-Limit, X-Credits-Remaining og X-Credits-Reset.
  • Op til 120 forespørgsler i minuttet pr. nøgle.
  • Op til 60 ændringer i minuttet pr. virksomhed, talt sammen med ændringer foretaget i my.to.co og via MCP.

Fejl

En fejl svarer med en HTTP-status og JSON: error (en meddelelse), code (en af koderne nedenfor) og request_id. Et 429-svar indeholder Retry-After.

  • invalid_request (400) — The body or a query value is not valid; the message says which field.
  • cookie_not_accepted (400) — The request carried a browser session. This API takes an API key only.
  • if_match_required (400) — A post change without If-Match.
  • not_ready (400) — The post cannot be published yet; problems lists why.
  • image_unknown (400) — A post body shows an image the post does not have. A key cannot upload images.
  • invalid_key (401) — No key, or one that is unknown, revoked or expired.
  • insufficient_scope (403) — The key does not have the scope this route needs.
  • plan_required (403) — The company plan does not include this scope now; plan_needed names the plan that does.
  • insufficient_role (403) — The person who made the key no longer has the role for this; an owner makes a new key.
  • not_found (404) — Not found. A host other than the key's own company is always not found.
  • registered_office (409) — The registered office comes from the company register and cannot be changed with a key.
  • post_changed (409) — The post changed since the If-Match version. Read it again.
  • post_deleted (409) — The post is in the bin.
  • not_draft (409) — Only a draft can be scheduled.
  • slug_taken (409) — Another post already uses that address.
  • rate_limited (429) — Too many requests. Wait for Retry-After.
  • credits_exhausted (429) — This month's API credits are used. They start again on the first of next month; there are no overage charges.
  • credits_unavailable (503) — The API cannot count credits right now. Try again later.

Webhooks

Med Grow kan to.co også sende signerede hændelser til din egen server, når noget ændres, f.eks. en ny besked eller en ændring af din virksomheds oplysninger. Opsæt dem i my.to.co under Webhooks.

Næste skridt

Sprog

Vælg blandt de sprog som hjemmesiden og appen understøtter fuldt ud.