cURL
curl -X GET "https://app.emailx.ai/api/v1/me" \
-H "Authorization: Bearer $EMAILX_API_KEY"import os, requests
response = requests.get(
"https://app.emailx.ai/api/v1/me",
headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json())const response = await fetch("https://app.emailx.ai/api/v1/me", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}` },
signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`Emailx: ${response.status}`);
console.log(await response.json());{
"data": {
"id": "docs_example",
"name": "Documentation example",
"environment": "live",
"actor_type": "client",
"actor_id": 123,
"workspace_ids": [
123
],
"scopes": [
"workspaces:read",
"campaigns:read"
],
"expires_at": "2026-11-30T12:00:00Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}Start here
Check your API key
Shows which environment the key belongs to, the permissions it was given and when it expires. Call this first to confirm the key works.
Permission: workspaces:read
GET
/
me
cURL
curl -X GET "https://app.emailx.ai/api/v1/me" \
-H "Authorization: Bearer $EMAILX_API_KEY"import os, requests
response = requests.get(
"https://app.emailx.ai/api/v1/me",
headers={"Authorization": "Bearer " + os.environ["EMAILX_API_KEY"]},
timeout=30,
)
response.raise_for_status()
print(response.json())const response = await fetch("https://app.emailx.ai/api/v1/me", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.EMAILX_API_KEY}` },
signal: AbortSignal.timeout(30000),
});
if (!response.ok) throw new Error(`Emailx: ${response.status}`);
console.log(await response.json());{
"data": {
"id": "docs_example",
"name": "Documentation example",
"environment": "live",
"actor_type": "client",
"actor_id": 123,
"workspace_ids": [
123
],
"scopes": [
"workspaces:read",
"campaigns:read"
],
"expires_at": "2026-11-30T12:00:00Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"request_id": "<string>",
"details": {}
}
}
