Get person
Retrieve a person by external ID.
curl -X GET "https://api.flameup.ai/api/v1/people/example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN"
import requests
import json
url = "https://api.flameup.ai/api/v1/people/example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.flameup.ai/api/v1/people/example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.flameup.ai/api/v1/people/example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.flameup.ai/api/v1/people/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
response = http.request(request)
puts response.body
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"workspace_id": "123e4567-e89b-12d3-a456-426614174000",
"userId": "example_string",
"email": "user@example.com",
"phone": "+1-555-0123",
"anonymousId": "example_string",
"traits": {},
"status": "active",
"unsubscribed_at": "2024-12-25T10:00:00Z",
"unsubscribe_reason": "example_string",
"created_at": "2024-12-25T10:00:00Z",
"updated_at": "2024-12-25T10:00:00Z"
}
{
"success": false,
"error": "Person not found",
"code": "example_string"
}
{
"error": "Unauthorized",
"message": "Invalid or expired API key",
"details": "Please provide a valid API key in the Authorization header: Bearer <your_api_key>"
}
{
"success": false,
"error": {
"code": "example_string",
"message": "example_string",
"details": {}
}
}
/people/{id}Target server for requests. Edit to use your own host.
Your Flameup API key (passed as Bearer token)
The person's external ID — the userId you send to /identify and /track. Email is NOT accepted here; the lookup keys on external ID only.
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token. Your Flameup API key (passed as Bearer token)
Path Parameters
The person's external ID — the userId you send to /identify and /track. Email is NOT accepted here; the lookup keys on external ID only.
Responses
The Flameup person UUID.
Your own user id — the external id you send to /identify and /track.
Empty string when the person has no email.
Empty string when the person has no phone.
Present only when the person carries an anonymous id.
The person's consent state: active, unsubscribed, bounced or suppressed. Serialized on every person read (get, list, search, the create/upsert echo for a key with people:read, and batch results), so treat it as always present. It is emitted verbatim rather than defaulted, so a row written before the column had a default can read back as an empty string — which is why this is not declared as a closed enum.
When the person unsubscribed. Present only when set.
Why the person unsubscribed. Present only when set.