La API de to.co
Deja que tu propio software, como un sitio web, un sistema de caja o un script, lea tu empresa en to.co y la mantenga al día. Las claves están en Pro y Grow.
Consigue una clave de API Rutas
- URL base
https://api.to.co/v1/orgs/{host}- Autenticación
Authorization: Bearer toco_ak_…
Consigue una clave de API
Abre tu empresa en my.to.co, elige Claves de API y luego Crear clave. Ponle un nombre, elige sus permisos y cuándo caduca (un año como máximo) y cópiala: se muestra una sola vez y solo se guarda un hash.
Envía la clave en la cabecera Authorization en cada solicitud. Una clave solo sirve para su propia empresa: cualquier otra dirección responde «no encontrado». La API solo acepta claves, nunca una sesión de navegador.
Ejemplo de llamada
curl https://api.to.co/v1/orgs/mybusiness.uk.to.co \
-H "Authorization: Bearer toco_ak_…"Permisos y planes
Una clave solo puede hacer lo que permiten sus permisos, y solo lo que incluye el plan de la empresa en el momento de cada solicitud. La lectura está en Pro y Grow; los cambios, en Grow.
| Permiso | Qué hace | Desde el plan |
|---|---|---|
company:read | Your company details, services and locations. | Pro |
messages:read | Messages from your contact form (not those held as spam). | Pro |
company:write | Replace your services, and change phone numbers and opening hours. | Grow |
posts:read | The posts you write on to.co, drafts included. | Pro |
posts:write | Write, save, publish, unpublish and delete posts. | Grow |
Rutas
Todas las rutas están bajo la URL base, con la dirección de to.co de tu empresa en lugar de {host}, por ejemplo mybusiness.uk.to.co. Las solicitudes y respuestas son JSON. Los cambios pasan por las mismas comprobaciones, el mismo historial y la misma republicación que los hechos en my.to.co, y quedan registrados como hechos por la clave.
| Ruta | Qué hace | Permiso |
|---|---|---|
GET /v1/orgs/{host} | The company record, with its services and locations. | company:read |
GET /v1/orgs/{host}/services | The services, in order. | company:read |
GET /v1/orgs/{host}/locations | The locations, with phones and opening hours. | company:read |
GET /v1/orgs/{host}/messages | Contact 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}/services | Replace 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}/posts | Posts 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}/posts | A 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}/publish | Publish the If-Match version. It is checked first, as when the owner publishes. | posts:write |
POST /v1/orgs/{host}/posts/{id}/unpublish | Take a post off the page and back to a draft. | posts:write |
Créditos y límites
- Cada solicitud usa un crédito de API, de la misma asignación mensual que las llamadas de tu propio asistente de IA al servidor MCP de tu empresa: 5,000 al mes por empresa en Pro y 50,000 en Grow. Una solicitud que falla devuelve su crédito. Los créditos empiezan de nuevo el día 1 de cada mes (UTC) y no hay cargos por exceso. Las respuestas llevan X-Credits-Limit, X-Credits-Remaining y X-Credits-Reset.
- Hasta 120 solicitudes por minuto por clave.
- Hasta 60 cambios por minuto por empresa, contados junto con los hechos en my.to.co y por MCP.
Errores
Un error responde con un estado HTTP y JSON: error (un mensaje), code (uno de los siguientes) y request_id. Un 429 lleva 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
En Grow, to.co también puede enviar eventos firmados a tu propio servidor cuando algo cambia, como un mensaje nuevo o un cambio en los datos de tu empresa. Configúralos en my.to.co, en Webhooks.