Página inicial do to.co
Começar

A API do to.co

Deixe seu próprio software, como um site, um sistema de caixa ou um script, ler sua empresa no to.co e mantê-la atualizada. As chaves estão nos planos Pro e Grow.

Obtenha uma chave de API Rotas

URL base
https://api.to.co/v1/orgs/{host}
Autenticação
Authorization: Bearer toco_ak_…

Obtenha uma chave de API

Abra sua empresa no my.to.co e escolha Chaves de API e depois Criar chave. Dê um nome, escolha os escopos e quando ela expira (em no máximo um ano) e copie a chave: ela é mostrada uma única vez e só um hash dela é guardado.

Envie a chave no cabeçalho Authorization em todas as solicitações. Uma chave funciona apenas para a própria empresa: qualquer outro endereço responde como não encontrado. A API aceita apenas chaves, nunca uma sessão do navegador.

Exemplo de chamada

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

Escopos e planos

Uma chave só pode fazer o que os escopos dela permitem, e só o que o plano da empresa inclui no momento de cada solicitação. A leitura está nos planos Pro e Grow; as alterações, no Grow.

EscopoO que fazA partir do plano
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

Rotas

Todas as rotas ficam sob a URL base, com o endereço to.co da sua empresa no lugar de {host}, por exemplo mybusiness.uk.to.co. Solicitações e respostas são em JSON. As alterações passam pelas mesmas verificações, histórico e nova publicação que as alterações feitas no my.to.co, registradas como feitas pela chave.

RotaO que fazEscopo
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

Créditos e limites

  • Cada solicitação usa um crédito de API, da mesma franquia mensal das chamadas do seu próprio assistente de IA ao servidor MCP do seu negócio: 5,000 por mês por empresa no Pro e 50,000 no Grow. Uma solicitação que falha devolve o crédito. Os créditos recomeçam no dia 1º de cada mês (UTC), e não há cobrança por excedente. As respostas trazem X-Credits-Limit, X-Credits-Remaining e X-Credits-Reset.
  • Até 120 solicitações por minuto por chave.
  • Até 60 alterações por minuto por empresa, contadas junto com as alterações feitas no my.to.co e pelo MCP.

Erros

Um erro responde com um status HTTP e JSON: error (uma mensagem), code (um dos códigos abaixo) e request_id. Um 429 traz 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

No Grow, o to.co também pode enviar eventos assinados ao seu próprio servidor quando algo muda, como uma nova mensagem ou uma alteração nos dados da sua empresa. Configure-os no my.to.co, em Webhooks.

Próximos passos

Idioma

Escolha entre os idiomas que o site e o aplicativo oferecem por completo.