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>'

import requests

url = "https://api.sprig.com/v2/users/{userId}"

headers = {"Authorization": "<authorization>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.sprig.com/v2/users/{userId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sprig.com/v2/users/{userId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sprig.com/v2/users/{userId}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sprig.com/v2/users/{userId}")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sprig.com/v2/users/{userId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

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