Get User Profile

curl --request GET \
  --url https://api.example.com/api/users/profile

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/users/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/api/users/profile"

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

	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.example.com/api/users/profile")

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

request = Net::HTTP::Get.new(url)

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

{
  "id": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "name": "<string>",
  "image": {},
  "company": {},
  "provider": "<string>",
  "isActive": true,
  "isAdmin": true,
  "isEmailVerified": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "subscription.plan": "<string>",
  "subscription.planName": "<string>",
  "subscription.status": "<string>",
  "subscription.spansUsed": 123,
  "subscription.spansLimit": 123,
  "subscription.usagePercentage": 123,
  "subscription.cancelAtPeriodEnd": true,
  "subscription.currentPeriodEnd": {},
  "subscription.features": {},
  "subscription.trialEndDate": {},
  "subscription.trialDaysRemaining": 123,
  "subscription.trialExpired": true,
  "resources.agentCount": 123,
  "resources.activeApiKeyCount": 123
}

GET

api

users

profile

Get User Profile

curl --request GET \
  --url https://api.example.com/api/users/profile

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/users/profile",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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.example.com/api/users/profile"

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

	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.example.com/api/users/profile")

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

request = Net::HTTP::Get.new(url)

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

{
  "id": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "name": "<string>",
  "image": {},
  "company": {},
  "provider": "<string>",
  "isActive": true,
  "isAdmin": true,
  "isEmailVerified": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "subscription.plan": "<string>",
  "subscription.planName": "<string>",
  "subscription.status": "<string>",
  "subscription.spansUsed": 123,
  "subscription.spansLimit": 123,
  "subscription.usagePercentage": 123,
  "subscription.cancelAtPeriodEnd": true,
  "subscription.currentPeriodEnd": {},
  "subscription.features": {},
  "subscription.trialEndDate": {},
  "subscription.trialDaysRemaining": 123,
  "subscription.trialExpired": true,
  "resources.agentCount": 123,
  "resources.activeApiKeyCount": 123
}

Get User Profile

Returns a comprehensive profile for the authenticated user, including subscription plan and features, and resource counts — all in a single call.

Authentication

Requires a valid JWT Bearer token.

curl -X GET https://api.getfoil.ai/api/users/profile \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Response

string

User ID

string

User email address

string

First name

string

Last name

string

Full display name (firstName + lastName)

string | null

Profile image URL

string | null

Company name

string

Auth provider: local, google, or github

boolean

Whether the account is active

boolean

Whether the user has admin privileges

boolean

Whether the email address has been verified

string

ISO 8601 account creation date

string

ISO 8601 last update date

`subscription`

Current plan, usage, and feature entitlements.

string

Plan key: trial, starter, or pro

string

Human-readable plan name: Free Trial, Starter, or Pro

string

Subscription status: trialing, active, canceled, past_due

number

Number of spans consumed in the current period

number

Maximum spans allowed in the current period

number

Percentage of span limit used (0–100)

boolean

Whether the subscription will cancel at the end of the current period

string | null

ISO 8601 date when the current billing period ends

object

Plan feature entitlements (see Features below)

string | null

ISO 8601 trial end date. Only present when plan is trial.

number

Days remaining in trial. Only present when plan is trial.

boolean

Whether the trial has expired. Only present when plan is trial.

Features

The subscription.features object contains plan entitlements. Numeric values of -1 mean unlimited.

Field	Type	Description
`spans`	number	Max spans per period (`-1` = unlimited)
`agents`	number	Max agents (`-1` = unlimited)
`retention`	number	Data retention in days (`-1` = unlimited)
`alerts`	boolean	Alert notifications enabled
`evaluations`	boolean	LLM evaluations enabled
`exports`	boolean	Data export enabled
`deepSearch`	boolean	Natural-language ClickHouse search
`semanticSearch`	boolean	Embedding-based semantic search
`smartSearch`	boolean	Unified intelligent search
`customLLMLogic`	boolean	Custom LLM evaluation logic
`modelTraining`	boolean	ML model training
`sso`	boolean	Single sign-on
`rbac`	boolean	Role-based access control
`support`	string	Support tier: `community`, `email`, or `priority`
`trialDays`	number	Length of trial period in days

`resources`

Account resource counts.

number

Total number of agents

number

Number of non-revoked API keys

Example Response

{
  "id": "664f1a2b3c4d5e6f7a8b9c0d",
  "email": "user@example.com",
  "firstName": "Jane",
  "lastName": "Doe",
  "name": "Jane Doe",
  "image": null,
  "company": null,
  "provider": "google",
  "isActive": true,
  "isAdmin": false,
  "isEmailVerified": true,
  "createdAt": "2026-01-07T10:00:00.000Z",
  "updatedAt": "2026-02-01T15:30:00.000Z",
  "subscription": {
    "plan": "trial",
    "planName": "Free Trial",
    "status": "trialing",
    "spansUsed": 0,
    "spansLimit": 10000,
    "usagePercentage": 0,
    "cancelAtPeriodEnd": false,
    "currentPeriodEnd": null,
    "features": {
      "spans": 10000,
      "agents": -1,
      "retention": -1,
      "alerts": true,
      "evaluations": true,
      "exports": true,
      "trialDays": 14,
      "deepSearch": true,
      "semanticSearch": false,
      "smartSearch": false,
      "support": "community"
    },
    "trialEndDate": "2026-02-21T00:00:00.000Z",
    "trialDaysRemaining": 14,
    "trialExpired": false
  },
  "resources": {
    "agentCount": 3,
    "activeApiKeyCount": 1
  }
}

Error Responses

Status	Description
401	Missing or invalid authentication
404	User not found

API Reference

Users

Get User Profile

Get User Profile

Authentication

Response

`subscription`

Features

`resources`

Example Response

Error Responses

​Get User Profile

​Authentication

​Response

​subscription

​Features

​resources

​Example Response

​Error Responses

Get User Profile

Authentication

Response

`subscription`

Features

`resources`

Example Response

Error Responses