Skip to main content
GET
/
sessions
/
{token}
Get Session Status
curl --request GET \
  --url https://api-sandbox.letshum.com/sessions/{token} \
  --header 'Authorization: Bearer <token>'
{
  "message": "What happened in the most recent request.",
  "request_status": "ok",
  "data": {
    "service_address": "1420 Washington Blvd, Detroit, MI 48201"
  },
  "meta": {
    "session_token": "XqCmeTVgYXrbWrZFZEymkD",
    "session_status": "open",
    "responded_at": "2024-09-20T23:13:31.179Z",
    "hum_data_set": "25041808",
    "agent_status": {
      "geocoding": "matched",
      "internet": "matched",
      "checkout": "pending"
    },
    "session_params": {
      "street1": "29090 Tiffany Drive E",
      "state": "MI",
      "zip": 48034,
      "street2": "A2",
      "city": "Southfield",
      "latitude": 42.501721339274,
      "longitude": -83.286263465881,
      "campaign_id": "1iYyMxsnTy87tFOvukTi7V"
    },
    "service_address": "1420 Washington Blvd, Detroit, MI 48201",
    "created_at": "2024-09-20T23:13:31.179Z",
    "updated_at": "2024-09-20T23:13:31.179Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer token authentication using JWT tokens. Include the token in the Authorization header as: Authorization: Bearer <token>

Obtain tokens through your Hum API account dashboard or contact [email protected] for access.

Path Parameters

token
string
required

The session token identifying the specific session The session token provided by the Hum API. Used to connect the response to the session in the client system.

Example:

"XqCmeTVgYXrbWrZFZEymkD"

Response

Session data retrieved successfully

message
string
required

A message returned by the API. Includes a human-readable message about the status of the request.

Example:

"What happened in the most recent request."

request_status
enum<string>
required

A status code summarizing the outcome of this response.

  • ok: Request was successful
  • warning: Request was processed but with some issues
  • error: Request failed
Available options:
ok,
warning,
error
Example:

"ok"

data
object
required
meta
object
required

Metadata about the session. Can be used to track the status of the session, time since creation, and time since last update.