Retrieve a User - Sprig Docs

GET

users

{userId}

Retrieve a User

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

{
  "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

API V2 user model

attributes

object

createdAt

number

events

object[]

Minimum array length: 1

Show child attributes

externalUserId

string | null

Minimum string length: 1

string

Minimum string length: 1

Upsert a User

Retrieve Responses

⌘I

Retrieve a User

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

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

Documentation Index

Headers

Path Parameters

Response