Skip to main content
GET
/
users
/
external
/
{external_id}
Get user by external ID
curl --request GET \
  --url https://api.spikelabs.com/v1/users/external/{external_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "user_abc123",
  "object": "user",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "metadata": {},
  "settings": {
    "memory_enabled": true
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Use your secret key (starts with sk_) as a Bearer token.

Path Parameters

external_id
string
required

Your external user identifier

Response

User details

id
string
required

Unique identifier

Example:

"user_abc123"

object
enum<string>
required
Available options:
user
created_at
string<date-time>
required
updated_at
string<date-time>
required
external_id
string | null

Your external user identifier

metadata
object

Custom user data (name, email, etc.)

settings
object