---
title: "GET /v1/users"
method: GET
path: "/v1/users"
tags: ["users"]
---

# GET /v1/users

`GET /v1/users`

## Request

- The document declares no server URL.
- Auth: HTTP bearer

Find a user by ID

## Query parameters

- `foreignId` string, required
- `userId` string, required

## Response `200`

The user was successfully found

- ExternalizedUser
  - `userId` string: The ID of the user as defined in your own application
  - `createdAt` string, date-time: The date and time the user was created
  - `modifiedAt` string, date-time: The date and time the user was last modified
  - `properties` string: The properties of the user
  - `isGuest` boolean: Whether the user is a guest
  - `email` string: The email address of the user
  - `firstName` string: The first name of the user
  - `lastName` string: The last name of the user
  - `userFlowStates` UserFlowState[]: The user's state in the Flows they have interacted with
    - `flowSlug` string, required: The ID of the Flow
    - `flowState` string, required: The user's state in the Flow. Possible values: `COMPLETED_FLOW`, `STARTED_FLOW`, `NOT_STARTED_FLOW`, `SKIPPED_FLOW`
    - `flowResponses` ExternalizedFlowResponse[]: The flow responses associated with the user
      - `flowSlug` string, required: The ID of the Flow
      - `stepId` string, required: The ID of the Step
      - `data` string, required: The data of the flow response (for instance form responses)
      - `actionType` string, required: The action type of the step. Possible values: `STARTED_STEP`, `COMPLETED_STEP`, `SKIPPED_STEP`, `NOT_STARTED_STEP`, `STARTED_FLOW`, `COMPLETED_FLOW`, `SKIPPED_FLOW`, `NOT_STARTED_FLOW`
      - `createdAt` string, date-time, required: The timestamp of the flow response
  - `trackingEvents` ExternalizedTrackingEvent[]: The tracking events associated with the user
    - `event` string, required: The name of the tracking event
    - `properties` object: The properties of the tracking event

## Other responses

- `404`: The user was not found

---

[API](https://skmtc.dev/frigadehq/apis/frigade-api.md) - [All operations](https://skmtc.dev/frigadehq/apis/frigade-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frigadehq/apis/frigade-api/revisions/92c033821b45?raw)