Skip to main content
GET
/
account
Get the current user's account information
curl --request GET \
  --url https://vanguard.profilebehavior.com/api/v4/account \
  --header 'Authorization: Bearer <token>'
{
  "code": 200,
  "data": {
    "id": "60e9ca73c500a9001534ad84",
    "createdAt": "2025-01-01T09:42:52.329056-05:00",
    "updatedAt": "2025-01-01T09:42:52.329056-05:00",
    "name": "Aperture Science",
    "type": "Corporate",
    "billing": {
      "status": "trialing",
      "trialEndDate": "2025-01-28T09:42:52.329056-05:00"
    },
    "reportsGenerated": 42,
    "trialReportsUsed": 3,
    "tags": []
  },
  "status": "success"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

includeTags
boolean
default:false

Whether to include the tags available on the current account and include them as a "tags" field.

Response

Success

Standard response object for successful single-resource requests in the Profile Behavior API. Contains an HTTP status code, the returned resource data, and a status indicator.

code
integer<int32>
required

HTTP status code of the successful response.

status
enum<string>

Always "success" for successful responses.

Available options:
success
data
object

Base schema that provides unique identification and timestamp metadata for resources in the Profile Behavior API.

Represents an organization, department, or team within the Profile platform. Accounts manage assessment credits, preferences, and user access.