auth API reference | AppointmentTrader

Search all endpoints

/v1/auth/

Auth session management endpoints for native v2 account surfaces. Email-code and Google-state initiation are public by design. Session-management endpoints are authenticated-only. They expose the viewer's active browser sessions, allow a user to remove one session, remove every other session, or remove all sessions. Removing the current browser session clears the current browser session cookie and returns signedOut=true so native v2 clients can hard-navigate into the logged-out shell.

GET

/v1/auth/get_sessions

Return the authenticated user's active sessions, with the current browser session marked for display on the native v2 Session Manager.

Request example (cURL)

curl --get \
  'https://ca.appointmenttrader.com/v1/auth/get_sessions' \
  --data-urlencode 'key={{API_KEY}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`auth_get_sessions_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.sessions[].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession`		`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.otherSessions[].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessionCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.signedOut`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.redirectUrl`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/get_sessions",
    "RequestUserAlias": "example-user",
    "Payload": {
        "sessions": [],
        "currentSession": {
            "sessionID": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdLabel": "synthetic-example",
            "lastActivityDate": "synthetic-example",
            "lastActivityLabel": "synthetic-example",
            "ip": "synthetic-example",
            "city": "synthetic-example",
            "country": "synthetic-example",
            "locationLabel": "synthetic-example",
            "deviceLabel": "synthetic-example",
            "browserLabel": "synthetic-example",
            "agent": "synthetic-example",
            "lastOrigin": "synthetic-example",
            "releaseVersion": "synthetic-example",
            "buildMode": "synthetic-example",
            "clientType": "synthetic-example",
            "isCurrent": false,
            "isAlternativePortalSession": false
        },
        "otherSessions": [],
        "currentSessionID": "synthetic-example",
        "otherSessionCount": 0,
        "signedOut": false,
        "redirectUrl": "synthetic-example"
    }
}

Machine-readable endpoint documentation

POST

/v1/auth/set_all_sessions_removed

Remove every active session owned by the authenticated user, including the current browser session. The browser cookie is expired and the response includes signedOut=true.

Parameters

Name	Type	Required	Default	Description
`isWritingRequest`	`bool`	`No`	`false`	Set true to actually remove all sessions.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/auth/set_all_sessions_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`auth_set_all_sessions_removed_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.sessions[].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession`		`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.otherSessions[].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessionCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.signedOut`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.redirectUrl`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_all_sessions_removed",
    "RequestUserAlias": "example-user",
    "Payload": {
        "sessions": [],
        "currentSession": {
            "sessionID": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdLabel": "synthetic-example",
            "lastActivityDate": "synthetic-example",
            "lastActivityLabel": "synthetic-example",
            "ip": "synthetic-example",
            "city": "synthetic-example",
            "country": "synthetic-example",
            "locationLabel": "synthetic-example",
            "deviceLabel": "synthetic-example",
            "browserLabel": "synthetic-example",
            "agent": "synthetic-example",
            "lastOrigin": "synthetic-example",
            "releaseVersion": "synthetic-example",
            "buildMode": "synthetic-example",
            "clientType": "synthetic-example",
            "isCurrent": false,
            "isAlternativePortalSession": false
        },
        "otherSessions": [],
        "currentSessionID": "synthetic-example",
        "otherSessionCount": 0,
        "signedOut": false,
        "redirectUrl": "synthetic-example"
    }
}

Machine-readable endpoint documentation

POST

/v1/auth/set_google_oauth_state

Create signed Google OAuth state, including optional signup-page context. Public-by-design: anonymous users must be able to begin Google authentication.

Parameters

Name	Type	Required	Default	Description
`signupContext`	`string`	`No`	`""`	Optional base64 JSON {path,locationID,capturedAt}; capturedAt is Unix seconds.
`isWritingRequest`	`bool`	`No`	`false`	Set true to issue state and its anti-CSRF cookie.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/auth/set_google_oauth_state' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'signupContext={{signupContext}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Parameters: signupContext

Field	Type	Required	Description
`signupContext`	`string (application/json)`	`No`
`signupContext`	`object (decoded JSON)`	`No`
`signupContext.path`	`string`	`Yes`
`signupContext.locationID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`signupContext.locationID.oneOf[0]`	`integer`	`No`
`signupContext.locationID.oneOf[1]`	`string`	`No`
`signupContext.capturedAt`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`signupContext.capturedAt.oneOf[0]`	`integer`	`No`
`signupContext.capturedAt.oneOf[1]`	`string`	`No`

Response fields

Field	Type	Required
`$`	`auth_set_google_oauth_state_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].State`	`= "Success"`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].Payload`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].State`	`= "Failed"`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].ErrorMessage`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_google_oauth_state",
    "RequestUserAlias": "example-user",
    "Payload": {
        "State": "Success",
        "Payload": "synthetic-example"
    }
}

Machine-readable endpoint documentation

POST

/v1/auth/set_other_sessions_removed

Remove every active session except the current browser session. The viewer remains signed in on this device and receives a refreshed list.

Parameters

Name	Type	Required	Default	Description
`isWritingRequest`	`bool`	`No`	`false`	Set true to actually remove other sessions.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/auth/set_other_sessions_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`auth_set_other_sessions_removed_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.sessions[].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession`		`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.otherSessions[].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessionCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.signedOut`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.redirectUrl`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_other_sessions_removed",
    "RequestUserAlias": "example-user",
    "Payload": {
        "sessions": [],
        "currentSession": {
            "sessionID": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdLabel": "synthetic-example",
            "lastActivityDate": "synthetic-example",
            "lastActivityLabel": "synthetic-example",
            "ip": "synthetic-example",
            "city": "synthetic-example",
            "country": "synthetic-example",
            "locationLabel": "synthetic-example",
            "deviceLabel": "synthetic-example",
            "browserLabel": "synthetic-example",
            "agent": "synthetic-example",
            "lastOrigin": "synthetic-example",
            "releaseVersion": "synthetic-example",
            "buildMode": "synthetic-example",
            "clientType": "synthetic-example",
            "isCurrent": false,
            "isAlternativePortalSession": false
        },
        "otherSessions": [],
        "currentSessionID": "synthetic-example",
        "otherSessionCount": 0,
        "signedOut": false,
        "redirectUrl": "synthetic-example"
    }
}

Machine-readable endpoint documentation

POST

/v1/auth/set_send_login_code

Send an email login code using the existing authentication flow. A new account retains optional signup-page context independently from its post-login return destination. Public-by-design: anonymous users must be able to begin email authentication.

Parameters

Name	Type	Required	Default	Description
`email`	`string`	`Yes`	`—`	Email address to authenticate.
`origin`	`string`	`No`	`"Sign in"`	Existing auth action label.
`originalRequest`	`string`	`No`	`""`	Base64-encoded post-login return URL.
`signupContext`	`string`	`No`	`""`	Optional base64 JSON {path,locationID,capturedAt}; capturedAt is Unix seconds.
`isWritingRequest`	`bool`	`No`	`false`	Set true to send the code.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/auth/set_send_login_code' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'email={{email}}' \
  --data-urlencode 'origin={{origin}}' \
  --data-urlencode 'originalRequest={{originalRequest}}' \
  --data-urlencode 'signupContext={{signupContext}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Parameters: signupContext

Field	Type	Required	Description
`signupContext`	`string (application/json)`	`No`
`signupContext`	`object (decoded JSON)`	`No`
`signupContext.path`	`string`	`Yes`
`signupContext.locationID`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`signupContext.locationID.oneOf[0]`	`integer`	`No`
`signupContext.locationID.oneOf[1]`	`string`	`No`
`signupContext.capturedAt`	`DatabaseInteger`	`No`	Integer value; legacy MySQL reads may serialize it as a numeric string.
`signupContext.capturedAt.oneOf[0]`	`integer`	`No`
`signupContext.capturedAt.oneOf[1]`	`string`	`No`

Response fields

Field	Type	Required	Description
`$`	`auth_set_send_login_code_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`		`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].State`	`= "Success"`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[0].URL`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].State`	`= "Failed"`	`Yes`
`$.oneOf[0].allOf[1].Payload.oneOf[1].ErrorMessage`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[2]`	`object`	`Yes`	Legacy authenticate.php exits directly after a checkout email-binding failure, before CallLegacyEndpoint can wrap this JSON.
`$.oneOf[2].State`	`= "Failed"`	`Yes`
`$.oneOf[2].ErrorMessage`	`string`	`Yes`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_send_login_code",
    "RequestUserAlias": "example-user",
    "Payload": {
        "State": "Success",
        "URL": "synthetic-example"
    }
}

Machine-readable endpoint documentation

POST

/v1/auth/set_session_removed

Remove one active session owned by the authenticated user. If that session is the current browser session, the browser cookie is expired and the response includes signedOut=true.

Parameters

Name	Type	Required	Default	Description
`sessionID`	`string`	`Yes`	`—`	Session token returned by get_sessions.
`isWritingRequest`	`bool`	`No`	`false`	Set true to actually remove the session.

Request example (cURL)

curl --request POST \
  'https://ca.appointmenttrader.com/v1/auth/set_session_removed' \
  --data-urlencode 'key={{API_KEY}}' \
  --data-urlencode 'sessionID={{sessionID}}' \
  --data-urlencode 'isWritingRequest={{isWritingRequest}}'

Returns

JSON

See the shared response schema and synthetic example.

Response fields

Field	Type	Required
`$`	`auth_set_session_removed_Response`	`Yes`
`$.oneOf[0]`		`Yes`
`$.oneOf[0].allOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[0].RequestUserAlias`	`string`	`Yes`
`$.oneOf[0].allOf[0].RequestPath`	`string \| null`	`Yes`
`$.oneOf[0].allOf[0].RequestStatus`	`= "Succeeded"`	`Yes`
`$.oneOf[0].allOf[0].ResponseCode`	`integer`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[0].allOf[0].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[0].allOf[0].RequestImpersonatedByUserAlias`	`string`	`No`
`$.oneOf[0].allOf[1]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.sessions[].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.sessions[].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession`		`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0]`	`object`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[0].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSession.anyOf[1]`	`null`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions`	`array`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[]`	`object`	`No`
`$.oneOf[0].allOf[1].Payload.otherSessions[].sessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].createdDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].createdLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityDate`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastActivityLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].ip`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].city`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].country`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].locationLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].deviceLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].browserLabel`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].agent`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].lastOrigin`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].releaseVersion`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].buildMode`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].clientType`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].isCurrent`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessions[].isAlternativePortalSession`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.currentSessionID`	`string`	`Yes`
`$.oneOf[0].allOf[1].Payload.otherSessionCount`	`integer`	`Yes`
`$.oneOf[0].allOf[1].Payload.signedOut`	`boolean`	`Yes`
`$.oneOf[0].allOf[1].Payload.redirectUrl`	`string`	`Yes`
`$.oneOf[1]`	`object`	`Yes`
`$.oneOf[1].RequestUserAlias`	`string`	`Yes`
`$.oneOf[1].RequestPath`	`string \| null`	`Yes`
`$.oneOf[1].RequestStatus`	`= "Failed"`	`Yes`
`$.oneOf[1].ResponseCode`	`integer`	`Yes`
`$.oneOf[1].ResponseMessage`	`APIResponseMessage`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[0]`	`string \| number \| boolean \| null`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1]`	`array`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[1][]`	`APIResponseMessage`	`No`
`$.oneOf[1].ResponseMessage.oneOf[2]`	`object`	`Yes`
`$.oneOf[1].ResponseMessage.oneOf[2].*`	`APIResponseMessage`	`No`
`$.oneOf[1].RequestImpersonatedByUserAlias`	`string`	`No`

Response example

{
    "RequestStatus": "Succeeded",
    "ResponseCode": 100,
    "ResponseMessage": "Synthetic success example.",
    "RequestPath": "/v1/auth/set_session_removed",
    "RequestUserAlias": "example-user",
    "Payload": {
        "sessions": [],
        "currentSession": {
            "sessionID": "synthetic-example",
            "createdDate": "synthetic-example",
            "createdLabel": "synthetic-example",
            "lastActivityDate": "synthetic-example",
            "lastActivityLabel": "synthetic-example",
            "ip": "synthetic-example",
            "city": "synthetic-example",
            "country": "synthetic-example",
            "locationLabel": "synthetic-example",
            "deviceLabel": "synthetic-example",
            "browserLabel": "synthetic-example",
            "agent": "synthetic-example",
            "lastOrigin": "synthetic-example",
            "releaseVersion": "synthetic-example",
            "buildMode": "synthetic-example",
            "clientType": "synthetic-example",
            "isCurrent": false,
            "isAlternativePortalSession": false
        },
        "otherSessions": [],
        "currentSessionID": "synthetic-example",
        "otherSessionCount": 0,
        "signedOut": false,
        "redirectUrl": "synthetic-example"
    }
}

Machine-readable endpoint documentation