---
title: "Get a session by user id"
url: https://docs.gleap.ai/en/reference/rest-api/find-session-by-user-id
method: GET
path: "/sessions/by-user-id/{userId}"
api: "API Reference"
tag: "Session"
operationId: "FindSessionByUserId"
updatedAt: "2026-11-01T18:40:15.677Z"
language: en
---

# Get a session by user id

`GET https://api.gleap.io/v3/sessions/by-user-id/{userId}`

Get a session by the contact's external user id (`Session.userId`, the id your app passes to the SDK identify call), not the Mongo `_id`. Responds 404 when no contact with that userId exists.

## Authorization

- `Authorization` (header, required): `Bearer <token>`

## Headers

- `project` (string, required)

## Example request

```bash
curl --request GET \
  --url 'https://api.gleap.io/v3/sessions/by-user-id/{userId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'project: <project>'
```

## Responses

### 200 (`application/json`)

Ok

- `eventData` (any)
- `checklistTasks` (any)
- `lastSurveySentAt` (string<date-time>)
- `lastOutboundSentAt` (object)
  - `whatsapp` (string<date-time>)
  - `email` (string<date-time>)
  - `push` (string<date-time>)
- `outboundPending` (any)
- `outboundHistory` (any)
- `plan` (string)
- `telegramUsername` (string)
- `telegramChatId` (string)
- `instagramUsername` (string)
- `instagramId` (string)
- `facebookId` (string)
- `phone` (string)
- `sla` (number<double>)
- `companyName` (string)
- `mergedInto` (string)
- `emailLinkedFor` (string)
- `emailVerifiedFor` (string)
- `emailVerifiedAt` (string<date-time>)
- `emailVerified` (boolean)
- `portalShowIdentity` (boolean)
- `portalVerifiedEmail` (string)
- `portalEmailVerifiedAt` (string<date-time>)
- `platform` (string)
- `deviceType` (string)
- `companyId` (string)
- `avatar` (string)
- `location` (any)
- `lastPageView` (any)
- `emailBounceStream` (string)
- `emailBouncedAt` (string<date-time>)
- `emailBounced` (boolean)
- `unsubscribedAt` (string<date-time>)
- `unsubscribeReason` (string)
- `lastFeedbackReport` (string<date-time>)
- `lastActivity` (string<date-time>)
- `lastHeardFrom` (string<date-time>)
- `gleapHash` (string)
- `gleapId` (string)
- `customData` (any)
- `project` (object)
  - `isValid` (object)
  - `createFromHexString` (object)
  - `createFromTime` (object)
  - `generate` (object)
  - `cacheHexString` (any)
  - `prototype` (string)
- `email` (string)
- `organisation` (object)
  - `isValid` (object)
  - `createFromHexString` (object)
  - `createFromTime` (object)
  - `generate` (object)
  - `cacheHexString` (any)
  - `prototype` (string)
- `name` (string)
- `userId` (string)
- `countFeedbackComments` (number<double>, required)
- `countFeedbackReports` (number<double>, required)
- `identityHistory` (object[], required)
  - `changes` (object)
    - `email` (object)
      - `to` (string)
      - `from` (string)
    - `name` (object)
      - `to` (string)
      - `from` (string)
    - `userId` (object)
      - `to` (string)
      - `from` (string)
  - `by` (object)
    - `referer` (string)
    - `originalUrl` (string)
    - `hasApiKey` (boolean)
    - `userEmail` (string)
    - `source` (string)
    - `method` (string)
    - `userId` (string)
  - `_id` (any)
  - `at` (string<date-time>, required)
- `memory` (object[], required)
  - `actorUserId` (object)
    - `isValid` (object)
    - `createFromHexString` (object)
    - `createFromTime` (object)
    - `generate` (object)
    - `cacheHexString` (any)
    - `prototype` (string)
  - `actor` (string, required)
  - `updatedAt` (string<date-time>, required)
  - `createdAt` (string<date-time>, required)
  - `content` (string, required)
  - `description` (string, required)
  - `name` (string, required)
- `sessions` (number<double>, required)
- `emailOnly` (boolean, required)
- `blocked` (boolean, required)
- `unsubscribed` (boolean, required)
- `firstActivity` (string<date-time>, required)
- `lang` (string, required)
- `value` (number<double>, required)
- `updatedAt` (string<date-time>, required)
- `createdAt` (string<date-time>, required)
- `tags` (string[], required)
- `_id` (string, required)

```json
{
  "lastSurveySentAt": "2026-01-01T12:00:00Z",
  "lastOutboundSentAt": {
    "whatsapp": "2026-01-01T12:00:00Z",
    "email": "2026-01-01T12:00:00Z",
    "push": "2026-01-01T12:00:00Z"
  },
  "plan": "string",
  "telegramUsername": "string",
  "telegramChatId": "string",
  "instagramUsername": "string",
  "instagramId": "string",
  "facebookId": "string",
  "phone": "string",
  "sla": 0,
  "companyName": "string",
  "mergedInto": "string",
  "emailLinkedFor": "string",
  "emailVerifiedFor": "string",
  "emailVerifiedAt": "2026-01-01T12:00:00Z",
  "emailVerified": true,
  "portalShowIdentity": true,
  "portalVerifiedEmail": "string",
  "portalEmailVerifiedAt": "2026-01-01T12:00:00Z",
  "platform": "string",
  "deviceType": "string",
  "companyId": "string",
  "avatar": "string",
  "emailBounceStream": "string",
  "emailBouncedAt": "2026-01-01T12:00:00Z",
  "emailBounced": true,
  "unsubscribedAt": "2026-01-01T12:00:00Z",
  "unsubscribeReason": "string",
  "lastFeedbackReport": "2026-01-01T12:00:00Z",
  "lastActivity": "2026-01-01T12:00:00Z",
  "lastHeardFrom": "2026-01-01T12:00:00Z",
  "gleapHash": "string",
  "gleapId": "string",
  "project": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {}
  },
  "email": "string",
  "organisation": {
    "isValid": {},
    "createFromHexString": {},
    "createFromTime": {},
    "generate": {}
  },
  "name": "string",
  "userId": "string",
  "countFeedbackComments": 0,
  "countFeedbackReports": 0,
  "identityHistory": [
    {
      "changes": {
        "email": {
          "to": "string",
          "from": "string"
        },
        "name": {
          "to": "string",
          "from": "string"
        },
        "userId": {
          "to": "string",
          "from": "string"
        }
      },
      "by": {
        "referer": "string",
        "originalUrl": "string",
        "hasApiKey": true,
        "userEmail": "string",
        "source": "string",
        "method": "string",
        "userId": "string"
      },
      "at": "2026-01-01T12:00:00Z"
    }
  ],
  "memory": [
    {
      "actorUserId": {
        "isValid": {},
        "createFromHexString": {},
        "createFromTime": {},
        "generate": {}
      },
      "actor": "string",
      "updatedAt": "2026-01-01T12:00:00Z",
      "createdAt": "2026-01-01T12:00:00Z",
      "content": "string",
      "description": "string",
      "name": "string"
    }
  ],
  "sessions": 0,
  "emailOnly": true,
  "blocked": true,
  "unsubscribed": true,
  "firstActivity": "2026-01-01T12:00:00Z",
  "lang": "string",
  "value": 0,
  "updatedAt": "2026-01-01T12:00:00Z",
  "createdAt": "2026-01-01T12:00:00Z",
  "tags": [
    "string"
  ],
  "_id": "string"
}
```