Sign in

v1

latestOpenAPI 3.1.02026-07-26261466.6 KB
Platform connect

Get a connect session

Poll a session's status. connected_organization_id appears once the company completes the flow. The one-time code itself is never returned here — it only rides the redirect.

get/api/v2/platform_connect_sessions/{session_id}

Path parameters

session_idstring required

Response

The session.

idstring

Session id (pcs_…). Use it to poll status and exchange the code.

objectstring
status'pending' | 'bound' | 'completed' | 'claimed' | 'expired'

pending → the company hasn't finished the hosted flow. bound → the company picked an organization but hasn't confirmed yet. completed → the code was issued and is ready to exchange. claimed → you already exchanged it. expired → the link lapsed.

return_urlstring
statestring nullable

Your opaque passthrough value, echoed on the final redirect.

sandboxboolean

Deprecated spelling of test_mode.

test_modeboolean

Inherited from the credential that created the session.

connected_organization_idstring nullable

The connected organization, present once the company completes the flow.

created_atstring date-time
completed_atstring date-time nullable
expires_atstring date-time

The hosted link expires 60 minutes after creation.

Example response

{
  "object": "platform_connect_session"
}