Lobster Platform API (Preview)

The Lobster Platform API is a REST API of the Lobster Data Platform. It targets headless scenarios and AI agents that query platform content without the web UI. In the current version, the API provides read access to profiles, integration partners, and their channels.

Preview status (v1): The API is under active development. Breaking changes to endpoints and schemas can occur at any time, even though we avoid them where possible. Backward compatibility is only guaranteed once a stable version is released.

Availability

The API is available as of version 26.3.0. All endpoints are read-only (GET).

The base URL is:

https://<host>/platform/api/preview/

An interactive API reference with all endpoints and schemas is available in the documentation portal, current as of July 10, 2026. You can retrieve the OpenAPI specification at /platform/api/preview/openapi.json.

Authentication

Every request requires a bearer token in the HTTP header:

Authorization: Bearer <token>

You can obtain the token in three ways.

OAuth2 client credentials (machine to machine)

Create the client ID and client secret in the Lobster administration. Retrieve the token via the client credentials flow:

POST /dw/register/oauth/token
Content-Type: application/x-www-form-urlencoded

grant_type=client_credentials&client_id=<id>&client_secret=<secret>

Bearer token from a UI session

After logging in to the Lobster web client, exchange the session cookie for a bearer token:

GET /auth/sessionBearerToken

A GuestUser loginToken as a URL parameter establishes a session without a password. Then retrieve the bearer token as with a UI session:

GET https://<host>/?loginToken=<GuestUser token>
GET /auth/sessionBearerToken

Endpoints

Method and path	Description
`GET /platform/api/preview/profiles`	Lists all profiles the caller is allowed to view.
`GET /platform/api/preview/profiles/{id}`	Returns a single profile.
`GET /platform/api/preview/partners`	Lists all integration partners.
`GET /platform/api/preview/partners/{id}`	Returns a single integration partner.
`GET /platform/api/preview/partners/{partnerId}/channels`	Lists all channels of an integration partner.
`GET /platform/api/preview/partners/{partnerId}/channels/{id}`	Returns a single channel of an integration partner.

The Swagger UI of your instance contains details on the response schemas. This includes the fields of profiles and channel types, for example AS2, SFTP, HTTP, OFTP, and X.400.

Error handling

Failed requests return a uniform error envelope. The errorInfo object contains a machine-readable errorCode, a readable errorText, and the httpResponseStatus. Possible status codes are 400 (invalid request), 401 (not authenticated), 403 (no permission), 404 (not found), and 500 (server error).

Versioning and breaking changes

The following rules apply during the beta phase:

Change	Classification
New fields, enum values, or units are added	Non-breaking: Clients must tolerate unknown fields and values.
Existing fields, units, or enum values are removed or their type is changed	Breaking: Possible during the beta phase, but avoided where possible.

Once a stable v1 is released, breaking changes without a version change are no longer possible.

Current feature scope

The first Preview does not yet cover profiles completely. Integration units and response units are currently not included. They will be added as the API matures.

Documentation Index