Create session

Authenticates your organization using clientId and clientSecret. Returns a sessionId valid for 24 hours.

Optionally pass customerUid to scope the session to a specific user (sets deviceSessionType to User). Omit it for system-level operations (deviceSessionType: System).

The clientSecret is never sent again after this call. Store the returned sessionId and pass it on every subsequent request via the X-Session-Id header alongside X-Client-Id.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Your ClientId. Prefix indicates environment: ci_test_… = sandbox, ci_live_… = production.

string
required

Your ClientSecret. Shown once at credential creation. Keep it secret — treat it like a password.

string | null

The customerUid of the end-user this session acts on behalf of. Omit for autonomous system operations.

Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json