> ## Documentation Index
> Fetch the complete documentation index at: https://support.profilebehavior.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Account

> Returns details about the account associated with the authenticated user, including name, organization type, credits, and preference settings. Use this endpoint to confirm your account setup and view key metadata.




## OpenAPI

````yaml GET /account
openapi: 3.1.0
info:
  title: Profile Behavior API
  description: >
    Unlock actionable behavioral insights for leadership, teamwork, recruiting,
    and team culture.

    Profile delivers powerful assessments, analytics, and reporting for
    businesses, athletic teams, and higher education.


    For full product information, code samples, and API reference, see our
    [support documentation](https://support.profilebehavior.com).


    > **LLMs and AI agents**: See
    [llms.txt](https://support.profilebehavior.com/llms.txt) for a
    machine-readable index of all documentation pages.


    > **MCP connector:** LLM clients (ChatGPT apps, Claude connectors) speak to
    `/mcp` over streamable HTTP. They discover OAuth automatically via
    [/.well-known/oauth-protected-resource](https://vanguard.profilebehavior.com/.well-known/oauth-protected-resource),
    returned in the `WWW-Authenticate` header on any 401.


    > **Legacy manifests:**
      - [/.well-known/ai-plugin.json](https://vanguard.profilebehavior.com/.well-known/ai-plugin.json)
      - [/.well-known/mcp.json](https://vanguard.profilebehavior.com/.well-known/mcp.json)
  version: 3.0.0
  termsOfService: https://profilebehavior.com/legal/terms
  contact:
    name: Support
    url: https://profilebehavior.com/contact
    email: support@profilebehavior.com
  x-llm-sitemap: https://support.profilebehavior.com/llms.txt
  x-documentation-site: https://support.profilebehavior.com
  x-ai-plugin-manifest: https://vanguard.profilebehavior.com/.well-known/ai-plugin.json
  x-mcp-manifest: https://vanguard.profilebehavior.com/.well-known/mcp.json
  x-mcp-endpoint: https://vanguard.profilebehavior.com/mcp
  x-oauth-protected-resource: https://vanguard.profilebehavior.com/.well-known/oauth-protected-resource
servers:
  - url: https://vanguard.profilebehavior.com/api/v4
security:
  - M2M: []
  - OAuth2: []
tags:
  - name: test
    description: Endpoints for testing the API.
  - name: assessment_invites
    description: Information on sending invitations to take the assessment.
  - name: assessments
    description: Behavioral, leadership, and communication assessment endpoints.
  - name: accounts
    description: >-
      Endpoints for retrieving and managing account and organization
      information.
  - name: fixtures
    description: Endpoints for retrieving fixture data content such as report language.
  - name: playbook_ai
    description: Endpoints for generating and retrieving Playbook AI related content.
  - name: profiles
    description: Endpoints for individual behavioral profile management.
  - name: resource_aliases
    description: >-
      Endpoints for managing resource alias records that link Profile data to
      custom defined keys.
  - name: tags
    description: >-
      Endpoints for individual profile tags, categorization, and group
      management.
paths:
  /account:
    get:
      tags:
        - accounts
      summary: Get the current user's account information
      description: >
        Returns details about the account associated with the authenticated
        user, including name, organization type, credits, and preference
        settings. Use this endpoint to confirm your account setup and view key
        metadata.
      operationId: GetCurrentAccount
      parameters:
        - name: includeTags
          in: query
          description: >
            Whether to include the tags available on the current account and
            include them as a "tags" field.
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Success'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/Account'
              example:
                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: 1768336308
                  reportsGenerated: 42
                  trialReportsUsed: 3
                  tags: []
                status: success
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    Success:
      type: object
      description: >
        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.
      required:
        - code
      properties:
        code:
          type: integer
          format: int32
          description: HTTP status code of the successful response.
        status:
          type: string
          description: Always "success" for successful responses.
          enum:
            - success
    Account:
      allOf:
        - $ref: '#/components/schemas/BaseModel'
        - type: object
          description: >
            Represents an organization, department, or team within the Profile
            platform. Accounts manage assessment credits, preferences, and user
            access.
          required:
            - name
            - type
          properties:
            name:
              type: string
              description: >-
                The official name of the account, company, team, or
                organization.
            type:
              type: string
              description: Classification of the account or organization type.
              enum:
                - Corporate
                - Athletics
                - Higher-Education
            billing:
              type: object
              properties:
                status:
                  type: string
                  description: The current billing status of the account.
                trialEndDate:
                  type: string
                  format: date-time
                  description: >-
                    The date the free trial will expire on the account if
                    applicable.
                cancelAt:
                  type: integer
                  format: int64
                  description: >-
                    The date as a unix timestamp that the subscription will be
                    canceled at if applicable.
            reportsGenerated:
              type: integer
              format: int64
              description: The number of times a report has been accessed on this account.
            trialReportsUsed:
              type: integer
              format: int32
              description: >
                The number of reports created on this account during the trial
                period. This is only applicable for Trial accounts.
            tags:
              type: array
              description: An array of tags available on the account.
              items:
                $ref: '#/components/schemas/Tag'
                type: object
    BaseModel:
      type: object
      description: >
        Base schema that provides unique identification and timestamp metadata
        for resources in the Profile Behavior API.
      required:
        - id
        - createdAt
        - updatedAt
      properties:
        id:
          type: string
          description: Globally unique identifier for this resource.
        createdAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp indicating when the resource was created.
        updatedAt:
          type: string
          format: date-time
          description: ISO 8601 timestamp indicating when the resource was last updated.
    Tag:
      allOf:
        - $ref: '#/components/schemas/BaseModel'
        - type: object
          description: >
            Represents a tag used for organizing profiles, teams, or groups
            within an account. Tags allow for flexible grouping, filtering, and
            analytics across individuals and teams.
          required:
            - label
            - color
            - account
          properties:
            label:
              type: string
              description: The visible label for the tag (e.g., "Team", "Leadership").
            color:
              type: string
              description: >-
                The color assigned to the tag for UI display or analytics
                grouping.
              enum:
                - emerald
                - red
                - yellow
                - orange
                - blue
                - indigo
                - purple
                - pink
                - zinc
            profiles:
              type: array
              items:
                type: string
              description: An array of Profile IDs that this tag is applied to.
    Error:
      type: object
      description: >
        Standard error response object returned by the Profile Behavior API.
        Contains a machine-readable error code, a human-readable message, and
        detailed technical information for debugging or support purposes.
      required:
        - code
        - error
        - status
      properties:
        code:
          type: integer
          format: int32
          description: HTTP status code associated with the error.
        error:
          type: object
          required:
            - details
            - timestamp
          properties:
            message:
              type: string
              description: A human-readable summary describing the error.
            timestamp:
              type: string
              format: date-time
              description: ISO 8601 timestamp when the error occurred.
        status:
          type: string
          description: Always "error" for error responses.
          enum:
            - error
  responses:
    Unauthorized:
      description: Unauthorized - authentication required.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 401
            error:
              message: Invalid token
              timestamp: '2025-01-01T09:42:52.329056-05:00'
            status: error
    NotFound:
      description: Not Found - resource requested could not be located in the database.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            code: 404
            error:
              message: (resource) not found
              timestamp: '2025-01-01T09:42:52.329056-05:00'
            status: error
  securitySchemes:
    M2M:
      type: http
      scheme: bearer
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://login.profilebehavior.com/oauth/authorize
          tokenUrl: https://login.profilebehavior.com/oauth/token
          scopes:
            profiles:read: Read profiles and behavioral summaries (scores, AI debriefs)
            profiles:write: Create, update, delete profiles and send assessment invites
            tags:manage: Create, update, delete, and assign tags
            account:read: Read account details, assessments, and resource aliases
            account:write: Update account settings and resource aliases
      description: >
        OAuth 2.1 authorization code flow with PKCE. Use this whenever your

        integration acts on behalf of a specific Profile user: third-party

        apps, AI agents and MCP servers, and any browser-based or CLI tool

        a user signs in to.


        Tokens issued under this scheme are scoped to one Profile account

        (the one the user consented from) and carry OAuth scopes that

        narrow what the integration can do.


        Discovery is served at

        [/.well-known/oauth-protected-resource](/.well-known/oauth-protected-resource).

        The authorization server is Stytch Connected Apps, which supports

        Dynamic Client Registration for on-the-fly clients (e.g. MCP

        agents) in addition to pre-registered integrations.

````