Platform API overview

Base URL, authentication, data model and response codes for the Landbot Platform API.

The Platform API manages the channels, customers, messages and message hooks in your workspace from any HTTP client. Every endpoint lives under one base URL and takes the same token.

Info The other APIs have their own overview: APIchat, and the Bots API with the AI Agents and Channels APIs it works with.

Data model

• Channel: a connection between Landbot and a messaging service (web chat, WhatsApp, Facebook). GET /channels/
• Customer: a person who has talked to a bot through one channel. Each customer belongs to exactly one channel. GET /customers/
• Bot: a conversation flow you built in the builder. A customer can be assigned to a bot, an agent, or neither.

A conversation is the message stream between a customer and whoever is assigned to them. There is no conversation resource: every message endpoint addresses the customer.

Base URL

https://api.landbot.io/v1/

Every path in this reference is relative to this URL and ends with /. IDs in paths are numeric.

Authentication

Send your agent token in the Authorization header:

Authorization: Token YOUR_AGENT_TOKEN
Content-Type: application/json

Find your token at app.landbot.io/gui/settings/account. It acts as your agent, with your role's permissions. See Authentication.

Response codes

Error bodies, every error status and the 412 causes are in Errors. Request limits are in Rate limiting.