Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: Lobster Platform Channels API
description: '**PREVIEW:** This API is in preview and under active development. Endpoints and schemas are subject to breaking changes, and backward compatibility is not guaranteed until the API is promoted to a stable version.
REST API of the Lobster Platform for headless and AI-agent consumption.
## Authentication
Three authentication flows are available. All three produce a bearer token that must be sent as `Authorization: Bearer ` on every request.
### 1. OAuth2 Client Credentials (machine-to-machine)
Exchange a client id/secret provisioned in the Lobster administration UI:
```
POST /dw/register/oauth/token
Content-Type: application/x-www-form-urlencoded
grant_type=client_credentials&client_id=&client_secret=
```
### 2. UI Session Bearer Token
Log in via the Lobster web UI, then exchange the session cookie for a token:
```
GET /auth/sessionBearerToken
```
### 3. Guest User Login Token
Append a GuestUser `loginToken` as a URL query parameter to establish a session without a password, then retrieve the bearer token the same way:
```
GET ?loginToken=
GET /auth/sessionBearerToken
```
## Errors
Errors share a single envelope (see the `Error` schema): an `errorInfo` object with a machine-readable `errorCode`, a human-readable `errorText`, and the `httpResponseStatus`.'
version: preview
servers:
- url: https://api.lobster-world.com
security:
- OAuth2: []
- SessionBearer: []
tags:
- name: Channels
description: Manage communication channels of an integration partner.
paths:
/platform/api/preview/partners/{partnerId}/channels/{id}:
get:
tags:
- Channels
summary: Get channel by id
description: Returns a single channel by its identifier.
operationId: getChannelById
parameters:
- name: partnerId
in: path
description: Partner identifier.
required: true
schema:
type: integer
format: int64
- name: id
in: path
description: Channel identifier.
required: true
schema:
type: integer
format: int64
responses:
default:
description: default response
content:
application/json:
schema:
$ref: '#/components/schemas/core:IntegrationPartnerChannel'
title: IntegrationPartnerChannel
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'500':
$ref: '#/components/responses/ServerError'
components:
responses:
NotFound:
description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
x-ae-placeholder: true
Forbidden:
description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
x-ae-placeholder: true
BadRequest:
description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
x-ae-placeholder: true
Unauthorized:
description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
x-ae-placeholder: true
ServerError:
description: Referenced by this document but never defined in it. API Evangelist added this empty placeholder so the document resolves; the shape is unknown and is NOT a claim about the API.
x-ae-placeholder: true