Retrieve a User

Endpoint that allows the retrieval of a visitor based on a known User ID. This endpoint can only recover visitors with user IDs, so please ensure your Sprig implementation has user tracking configured correctly based on your SDK installation: /docs/Installation/introduction-web/index This endpoint will retrieve visitor info, a list of attributes tied to the visitor, and a list of events with relevant filter criteria.

GET /v2/users/{userId}

Retrieve a User

cURL

curl --request GET \
  --url https://api.sprig.com/v2/users/{userId} \
  --header 'Authorization: <authorization>'

200

{
  "attributes": {},
  "createdAt": 123,
  "events": [
    {
      "count": 123,
      "createdAt": 123,
      "event": "<string>",
      "updatedAt": 123
    }
  ],
  "externalUserId": "<string>",
  "id": "<string>"
}

Headers

Authorization · string · required

API-Key YOUR_API_KEY

Path Parameters

userId · string · required

Id of an existing user.

Response

200

application/json

OK

API V2 user model

attributes · object

createdAt · number

events · object[]

Minimum array length: 1

Show child attributes

externalUserId · string | null

Minimum string length: 1

id · string

Minimum string length: 1