KintsugiKintsugi
API reference / Validate plentyone credentials

Validate plentyone credentials

POST/connections/plentyone/validate

Probe a PlentyONE host/username/password without persisting a connection, returning the one synthetic system entity available under them. Returns 400 if authentication or the host fails to resolve. A multi-org credential must send an Organization-Id, Connection-Id or Entity-Id selector, or gets a 400.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Body

hoststringRequired

PlentyONE system URL or p{PID}.

usernamestringRequired

Terra Accounts username.

passwordstringRequired

Store login password.

Response

entitiesPlentyOneValidateEntity[]

Systems available under the validated credentials.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

422

The request failed validation.

cURL
POST /connections/plentyone/validate
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"host": "erp.example.com",
"username": "Jane Doe",
"password": "********"
}
Response
{
"entities": [
{
"id": "3f6c2b1e-8a4d-4c2e-9b1f-2d7e5a6c9f10",
"name": "Acme Corp"
}
]
}
Validate plentyone credentials (2026-07-21) | Kintsugi API Reference