Retrieve Person - Whop Docs

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.people.retrieve({
    id: "id"
});

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

fetch('https://api.whop.com/api/v1/people/{id}', 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.whop.com/api/v1/people/{id}",
  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: Bearer <token>"
  ],
]);

$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.whop.com/api/v1/people/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/people/{id}")

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

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

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

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "event_count": 42,
  "first_seen_at": "2026-01-01T12:00:00.000Z",
  "id": "prsn_123",
  "last_seen_at": "2026-01-01T12:00:00.000Z",
  "purchase_count": 2,
  "aov": 74.99,
  "audience_ids": [
    "Dana Whitfield"
  ],
  "custom_event_names": [
    "Dana Whitfield"
  ],
  "device": {
    "browser": "Dana Whitfield",
    "device": "Dana Whitfield",
    "os": "Dana Whitfield"
  },
  "email": "marcus@shinetime.example",
  "emails": [
    "Dana Whitfield"
  ],
  "event_names": [
    "Dana Whitfield"
  ],
  "first_purchase_at": "2026-01-01T12:00:00.000Z",
  "first_source": {
    "type": "ad_click",
    "ad": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "ad_group": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "campaign": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "domain": "Dana Whitfield",
    "occurred_at": "2026-01-01T12:00:00.000Z",
    "platform": "Dana Whitfield",
    "utm_source": "Dana Whitfield"
  },
  "last_ip": "Dana Whitfield",
  "last_purchase_at": "2026-01-01T12:00:00.000Z",
  "last_source": {
    "type": "ad_click",
    "ad": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "ad_group": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "campaign": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "domain": "Dana Whitfield",
    "occurred_at": "2026-01-01T12:00:00.000Z",
    "platform": "Dana Whitfield",
    "utm_source": "Dana Whitfield"
  },
  "location": {
    "city": "Dana Whitfield",
    "continent": "Dana Whitfield",
    "country": "Dana Whitfield"
  },
  "ltv": 149.98,
  "member": {
    "id": "mem_dana1",
    "joined_at": "2026-01-01T12:00:00.000Z",
    "status": "Dana Whitfield",
    "usd_total_spend": 149.98
  },
  "name": "Dana Whitfield",
  "names": [
    "Dana Whitfield"
  ],
  "phone": "+xxxxxxxxxxx",
  "phones": [
    "Dana Whitfield"
  ],
  "purchases": [
    {
      "event_id": "evt_2",
      "occurred_at": "2026-01-01T12:00:00.000Z",
      "usd_value": 74.99
    }
  ],
  "roles": [
    "Dana Whitfield"
  ],
  "sources": [
    {
      "type": "ad_click",
      "ad": {
        "id": "adcamp_1",
        "name": "Dana Whitfield",
        "thumbnail_url": "Dana Whitfield"
      },
      "ad_group": {
        "id": "adcamp_1",
        "name": "Dana Whitfield",
        "thumbnail_url": "Dana Whitfield"
      },
      "campaign": {
        "id": "adcamp_1",
        "name": "Dana Whitfield",
        "thumbnail_url": "Dana Whitfield"
      },
      "domain": "Dana Whitfield",
      "occurred_at": "2026-01-01T12:00:00.000Z",
      "platform": "Dana Whitfield",
      "utm_source": "Dana Whitfield"
    }
  ],
  "timezone": "Dana Whitfield",
  "usage": {
    "browser": [
      {
        "events": 10,
        "value": "Chrome"
      }
    ],
    "city": [
      {
        "events": 9,
        "value": "Austin"
      }
    ],
    "country": [
      {
        "events": 12,
        "value": "US"
      }
    ],
    "device": [
      {
        "events": 5,
        "value": "iPhone"
      }
    ],
    "ip": [
      {
        "events": 3,
        "value": "1.1.1.1"
      }
    ],
    "os": [
      {
        "events": 7,
        "value": "Mac OS X"
      }
    ],
    "referrer": [
      {
        "events": 4,
        "value": "google.com"
      }
    ],
    "timezone": [
      {
        "events": 12,
        "value": "America/Chicago"
      }
    ]
  },
  "user": {
    "id": "user_dana1",
    "username": "danawhitfield",
    "name": "Dana Whitfield",
    "profile_pic_url": "Dana Whitfield"
  },
  "user_ids": [
    "Dana Whitfield"
  ]
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

people

{id}

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.people.retrieve({
    id: "id"
});

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

fetch('https://api.whop.com/api/v1/people/{id}', 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.whop.com/api/v1/people/{id}",
  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: Bearer <token>"
  ],
]);

$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.whop.com/api/v1/people/{id}"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/people/{id}")

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

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

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

{
  "account_id": "biz_xxxxxxxxxxxxxx",
  "event_count": 42,
  "first_seen_at": "2026-01-01T12:00:00.000Z",
  "id": "prsn_123",
  "last_seen_at": "2026-01-01T12:00:00.000Z",
  "purchase_count": 2,
  "aov": 74.99,
  "audience_ids": [
    "Dana Whitfield"
  ],
  "custom_event_names": [
    "Dana Whitfield"
  ],
  "device": {
    "browser": "Dana Whitfield",
    "device": "Dana Whitfield",
    "os": "Dana Whitfield"
  },
  "email": "marcus@shinetime.example",
  "emails": [
    "Dana Whitfield"
  ],
  "event_names": [
    "Dana Whitfield"
  ],
  "first_purchase_at": "2026-01-01T12:00:00.000Z",
  "first_source": {
    "type": "ad_click",
    "ad": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "ad_group": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "campaign": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "domain": "Dana Whitfield",
    "occurred_at": "2026-01-01T12:00:00.000Z",
    "platform": "Dana Whitfield",
    "utm_source": "Dana Whitfield"
  },
  "last_ip": "Dana Whitfield",
  "last_purchase_at": "2026-01-01T12:00:00.000Z",
  "last_source": {
    "type": "ad_click",
    "ad": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "ad_group": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "campaign": {
      "id": "adcamp_1",
      "name": "Dana Whitfield",
      "thumbnail_url": "Dana Whitfield"
    },
    "domain": "Dana Whitfield",
    "occurred_at": "2026-01-01T12:00:00.000Z",
    "platform": "Dana Whitfield",
    "utm_source": "Dana Whitfield"
  },
  "location": {
    "city": "Dana Whitfield",
    "continent": "Dana Whitfield",
    "country": "Dana Whitfield"
  },
  "ltv": 149.98,
  "member": {
    "id": "mem_dana1",
    "joined_at": "2026-01-01T12:00:00.000Z",
    "status": "Dana Whitfield",
    "usd_total_spend": 149.98
  },
  "name": "Dana Whitfield",
  "names": [
    "Dana Whitfield"
  ],
  "phone": "+xxxxxxxxxxx",
  "phones": [
    "Dana Whitfield"
  ],
  "purchases": [
    {
      "event_id": "evt_2",
      "occurred_at": "2026-01-01T12:00:00.000Z",
      "usd_value": 74.99
    }
  ],
  "roles": [
    "Dana Whitfield"
  ],
  "sources": [
    {
      "type": "ad_click",
      "ad": {
        "id": "adcamp_1",
        "name": "Dana Whitfield",
        "thumbnail_url": "Dana Whitfield"
      },
      "ad_group": {
        "id": "adcamp_1",
        "name": "Dana Whitfield",
        "thumbnail_url": "Dana Whitfield"
      },
      "campaign": {
        "id": "adcamp_1",
        "name": "Dana Whitfield",
        "thumbnail_url": "Dana Whitfield"
      },
      "domain": "Dana Whitfield",
      "occurred_at": "2026-01-01T12:00:00.000Z",
      "platform": "Dana Whitfield",
      "utm_source": "Dana Whitfield"
    }
  ],
  "timezone": "Dana Whitfield",
  "usage": {
    "browser": [
      {
        "events": 10,
        "value": "Chrome"
      }
    ],
    "city": [
      {
        "events": 9,
        "value": "Austin"
      }
    ],
    "country": [
      {
        "events": 12,
        "value": "US"
      }
    ],
    "device": [
      {
        "events": 5,
        "value": "iPhone"
      }
    ],
    "ip": [
      {
        "events": 3,
        "value": "1.1.1.1"
      }
    ],
    "os": [
      {
        "events": 7,
        "value": "Mac OS X"
      }
    ],
    "referrer": [
      {
        "events": 4,
        "value": "google.com"
      }
    ],
    "timezone": [
      {
        "events": 12,
        "value": "America/Chicago"
      }
    ]
  },
  "user": {
    "id": "user_dana1",
    "username": "danawhitfield",
    "name": "Dana Whitfield",
    "profile_pic_url": "Dana Whitfield"
  },
  "user_ids": [
    "Dana Whitfield"
  ]
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

Authorizations

Authorization

string

header

required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-10-09-2"

Path Parameters

string

required

The person ID (prefixed prsn_), user ID (prefixed user_), email address, or phone number to look up. A merged person resolves to the surviving profile.

Query Parameters

account_id

string

Account ID, prefixed biz_. Optional for account API keys; required for credentials that can access multiple accounts.

Response

person retrieved

The full profile a retrieve returns: the summary plus every linked identity, purchase rows, all acquisition sources, and exact usage breakdowns.

account_id

string

required

Example:

"biz_xxxxxxxxxxxxxx"

event_count

integer

required

Example:

42

first_seen_at

string<date-time>

required

Example:

"2026-01-01T12:00:00.000Z"

string

required

Example:

"prsn_123"

last_seen_at

string<date-time>

required

Example:

"2026-01-01T12:00:00.000Z"

purchase_count

integer

required

Example:

2

aov

number

Example:

74.99

audience_ids

string[]

custom_event_names

string[]

device

object

Show child attributes

string | null

The email from the person's most recent event that carried one.

Example:

"marcus@shinetime.example"

emails

string[]

Every linked email, primary first.

event_names

string[]

first_purchase_at

string<date-time> | null

Example:

"2026-01-01T12:00:00.000Z"

first_source

object | null

Where a visit came from: a whop ad click, a lead form, an external ad, or a referring site.

Show child attributes

last_ip

string | null

Example:

"Dana Whitfield"

last_purchase_at

string<date-time> | null

Example:

"2026-01-01T12:00:00.000Z"

last_source

object | null

Where a visit came from: a whop ad click, a lead form, an external ad, or a referring site.

Show child attributes

location

object

Show child attributes

ltv

number

Example:

149.98

member

object | null

The user's member record at this account, when they are a member of it.

Show child attributes

name

string | null

The name from the person's most recent event that carried one.

Example:

"Dana Whitfield"

names

string[]

Every name the person's linked identities carried, primary first.

phone

string | null

The phone from the person's most recent event that carried one.

Example:

"+xxxxxxxxxxx"

phones

string[]

Every linked phone, primary first.

purchases

object[]

Show child attributes

roles

string[]

sources

object[]

Every distinct acquisition signal the person ever carried, ad entities hydrated.

Show child attributes

timezone

string | null

Example:

"Dana Whitfield"

usage

object

Exact usage breakdowns for the person's browser traffic (distinct events per value).

Show child attributes

user

object | null

The person's primary whop user, when one of their identities is a whop account.

Show child attributes

user_ids

string[]

Every linked whop account, the most used one first.