---
title: "Get user by key"
method: GET
path: "/v1/users/{userKey}"
tags: ["Users"]
---

# Get user by key

`GET /v1/users/{userKey}`

## Request

- Base URL: `https://api.streak.com/api`
- URL: `https://api.streak.com/api/v1/users/{userKey}`
- Auth: HTTP bearer

Returns information about a specific user by their key

## Path parameters

- `userKey` string, required

## Response `200`

OK

- User
  - `email` string, required: The user's normalized email address.
  - `creationTimestamp` integer, required: Timestamp when the user account was created, in epoch milliseconds.
  - `lastUpdatedTimestamp` integer, required: Timestamp when the user entity was last updated, in epoch milliseconds.
  - `lastSavedTimestamp` integer, required: Timestamp when the user entity was last persisted, in epoch milliseconds.
  - `lastSeenTimestamp` integer, nullable: Timestamp when Streak last saw activity for the user, in epoch milliseconds.
  - `googleProfileId` string, nullable: Stable Google profile identifier associated with the user's OAuth account.
  - `googleProfilePhotoUrl` string, nullable: URL of the user's Google profile photo, when available.
  - `avatarIcon` object, nullable: An icon with foreground and background colors.
    - `icon` 'smart_toy' | 'family_star' | 'headset_mic' | 'support_agent' | 'person_search' | 'document_search' | 'stethoscope' | 'insert_chart' | 'code_xml' | 'frame_bug' | 'build' | 'sell' | 'attach_money' | 'money_bag' | 'delivery_truck_speed' | 'package_2' | 'notifications' | 'handshake', required
    - `foregroundColor` string, required: Icon color as a hex CSS color.
    - `backgroundColor` string, required: Background color as a hex CSS color.
  - `googleProfileLink` string, nullable: URL of the user's Google profile, when available.
  - `googleProfileFullName` string, nullable: Full display name from the user's Google profile.
  - `googleProfileFirstName` string, nullable: Given name from the user's Google profile, when available.
  - `googleProfileLastName` string, nullable: Family name from the user's Google profile, when available.
  - `timezoneId` string, nullable: IANA timezone identifier for the user, such as America/Los_Angeles.
  - `userType` 'HUMAN' | 'AGENT', required
  - `securityReportOnTeamsPipelines` boolean: Whether security report emails are enabled for the user's team pipelines.
  - `externalSharingRestrictionOnTeamsPipelines` boolean: Whether external sharing is restricted on the user's team pipelines.
  - `automaticallySendInvoiceEmails` boolean: Whether invoice emails should be sent automatically for the user's billing context.
  - `emailsToSendInvoiceTo` string[], nullable: Additional email addresses that should receive invoice emails.
  - `customerSpecifiedInvoiceData` string, nullable: Customer-provided invoice data to include with billing records.
  - `firstOauthTimestamp` integer, nullable: Timestamp when the user first completed OAuth, in epoch milliseconds.
  - `wantsTaskDigestEmail` boolean: Whether the user wants to receive task digest emails.
  - `displayName` string, required: Display name Streak uses for the user in UI surfaces.
  - `key` string, required: Key for this user.

## Changes

- **2026-10-27** `a0b538f45125`: 1 info
  - added the optional property `avatarIcon` to the response with the `200` status
- **2026-10-16** `1c3a5ef8b9ea`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/streakyc/apis/streak/changes/v1/users/:userKey/get.md)

---

[API](https://skmtc.dev/streakyc/apis/streak.md) - [All operations](https://skmtc.dev/streakyc/apis/streak/llms.txt) - [OpenAPI document](https://skmtc.dev/streakyc/apis/streak/revisions/3648671fd1cf?raw)