Documentation Index

Fetch the complete documentation index at: https://docs.lobstersoftware.com/llms.txt

Use this file to discover all available pages before exploring further.

Get partner by id

Prev Next
Get
/platform/api/preview/partners/{id}

Returns a single integration partner by its identifier.

Security
OAuth

OAuth2 client-credentials flow for machine-to-machine access. Exchange a client id/secret at /dw/register/oauth/token for a bearer token, then send it as Authorization: Bearer <access_token>. Client credentials are provisioned in the Lobster administration UI.

FlowClient Credentials
Token URL/dw/register/oauth/token
Refresh URL/dw/register/oauth/token
HTTP
Type bearer

Bearer token obtained from an authenticated browser or guest-user session.

Flow 1 — UI login: Log in via the Lobster web UI at /, then call GET /auth/sessionBearerToken to exchange the session cookie for a bearer token.

Flow 2 — Guest user login token: Append a GuestUser loginToken as a URL query parameter to the base URL to establish a password-free session:

GET <host>?loginToken=<GuestUser token>

Then call GET /auth/sessionBearerToken to obtain the bearer token.

Path parameters
id
integer (int64) Required

Partner identifier.

Responses
400

The request was malformed or failed validation.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_validation_400",
    "errorLevel": 0,
    "errorText": "Invalid request payload."
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

401

Authentication is required or the supplied credentials are invalid.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_AuthenticationManager_401",
    "errorLevel": 0,
    "errorText": "You are not logged in"
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

403

The authenticated client is not permitted to perform this operation.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_permission_403",
    "errorLevel": 0,
    "errorText": "Access denied."
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

404

The requested resource does not exist.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_notFound_404",
    "errorLevel": 0,
    "errorText": "Resource not found."
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

500

An unexpected server error occurred.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_internalServerError_500",
    "errorLevel": 0,
    "errorText": "Server Error. See logs for more details."
  }
}
Expand All
object

Standard error envelope returned for all failed requests.

errorInfo
object
errorCode
string

Stable machine-readable error code for programmatic handling.

errorText
string

Human-readable, localized explanation of the error.

errorLevel
integer (int32)

Severity level of the error.

default

default response

object

core:IntegrationPartner

class
string
Valid values[ "core:IntegrationPartner" ]
id
integer (int64)
name
string