Find users by email, phone number or user id
Returns every users row matching exactly one key: email (case- and whitespace-insensitive), phone (E.164, any accepted international spelling) or userId (lower- or upper-case). Oldest first; more than one row only for legacy duplicates, and the first is the one the app resolves to. Never creates a user. Requires dual auth: X-Admin-API-Key + JWT.
curl -X GET "https://api.spkey.co/admin/users/lookup?email=user%40example.com&phone=%2B1-555-0123&userId=example_string" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY"
import requests
import json
url = "https://api.spkey.co/admin/users/lookup?email=user%40example.com&phone=%2B1-555-0123&userId=example_string"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.spkey.co/admin/users/lookup?email=user%40example.com&phone=%2B1-555-0123&userId=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.spkey.co/admin/users/lookup?email=user%40example.com&phone=%2B1-555-0123&userId=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
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.spkey.co/admin/users/lookup?email=user%40example.com&phone=%2B1-555-0123&userId=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 (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"by": "email",
"value": "example_string",
"total": 3.14,
"users": [
{
"uuid": "example_string",
"email": "null",
"phoneNumber": "null",
"createdAt": "example_string",
"updatedAt": "example_string"
}
]
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
{
"error": "Service Unavailable",
"message": "The service is temporarily unavailable. Please try again later",
"code": 503
}
/admin/users/lookup
Target server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
Email address; matched case- and whitespace-insensitively
Phone number in international form ("+48123456789" or "0048123456789"); matched on its E.164 form
b2c user UUID; lower- or upper-case
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Query Parameters
Email address; matched case- and whitespace-insensitively
Phone number in international form ("+48123456789" or "0048123456789"); matched on its E.164 form
b2c user UUID; lower- or upper-case
Responses
Which key was searched
emailphoneuserIdThe key as searched: lowercased email, E.164 phone number, or the UUID
Number of rows returned (capped at 50)