Skip to main content
POST
/
identify
TypeScript SDK
import Seerstack from 'seerstack';

const client = new Seerstack({
  apiKey: process.env['SEERSTACK_API_KEY'],
});

const response = await client.users.identify({
  user_id: 'user_123',
  email: '[email protected]',
  name: 'Grace Hopper',
  attributes: {
    plan: 'enterprise',
    team_size: 15,
    is_admin: true
  }
});

console.log(response.success);
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Use your SeerStack API key as a Bearer token. You can find your API key in the SeerStack Dashboard under Settings > Developer.

Body

application/json
​
user_id
string
required

Your internal user ID. Use a stable identifier like a database primary key.

Example:

"user_123"

​
email
string<email>

The user's email address.

Example:

"[email protected]"

​
name
string

The user's display name.

Example:

"Grace Hopper"

​
attributes
object

Custom attributes to associate with the user. These can be used for filtering in the dashboard.

Example:
{
  "plan": "enterprise",
  "team_size": 15,
  "is_admin": true
}

Response

User identified successfully

​
success
boolean
required

Indicates whether the operation was successful.

Example:

true