Get a link session
One time through Link, opened with one of your client sessions. The SDK returns its id (sessionId)
when Link closes; read the outcome here before you rely on it (or poll it on a timer).
Authorizations
Your integration's client credentials (test or live). The token acts as your integration's team and
lasts 1 hour; request a new one when it expires. Send client_id, client_secret and
grant_type=client_credentials. No OAuth scopes are needed.
- Token URL
- https://app.plugchoice.com/oauth/token
Headers
The API version to answer with (400 unknown-version for one this API does not know). Every response carries the version that answered in the same header.
2026-10-07 Path Parameters
Response
OK
One time through Link, opened with one of your client sessions.
integration when an integration created the client session, user when a Plugchoice user did.
user, integration What a link session does. add (the default) adds chargers; the others work on one charger: network
(its network settings), setup (its electrical setup), reconnect (bring it back to Plugchoice). Open:
any action the pattern allows is accepted, and the hosted flow decides what it means; for one it can't
do, it shows what the charger can do.
^[a-z_]{1,32}$"add"
"network"
"setup"
"reconnect"
The kind of device. Only chargers for now; another type is 422 unsupported-device-type.
charger A link session is opened when Link starts it, then completed | abandoned | expired (not finished
within 6 h).
opened, completed, abandoned, expired Chargers finished in this link session. Empty unless completed.
The same chargers as devices, as the SDK returns them.
Claims this link session started. They can still succeed after it ended; the charger then appears at site_id.
The 6 h cap.
Your own id for one of your users.
1 - 200^[A-Za-z0-9._:@-]+$Null until the hosted flow has the address, when the client session didn't name a site.
The charger a link session other than add is for.
cancelled, consent_declined, error, null Set when abandon_reason is error.