Skip to main content
POST
Test the LabelGrid connection

Description

cleanly: with no provider seeded, no configured row, or no stored token, it returns HTTP 200 with data.ok: false and a specific code, making no network call at all. A completed diagnostic is a successful request even when the verdict is “not connected” — the envelope status stays success. Defaults to the workspace’s saved environment; an optional environment override lets an owner verify a sandbox token before switching the workspace over. Authorization:
  • Required role: owner only

Code Examples

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
environment
enum<string>

One-off override of the workspace's saved environment for this test only.

Available options:
production,
sandbox

Response

Success - the diagnostic completed. Check data.ok / data.code for the actual connection verdict.

status
string
Example:

"success"

message
string
Example:

"LabelGrid connection verified"

data
object