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

# Read your account profile

> Requires a verified Firebase ID token or signed, active personal MCP token. Team API keys and OAuth client credentials cannot act as their creator. Firebase callers may access their own identity before joining a team. MCP callers remain subject to current credential/team authorization. Authentication is verified in the backend, including when requests pass through the API gateway.



## OpenAPI

````yaml openapi.json GET /users/me
openapi: 3.0.3
info:
  title: gigstack API v2
  description: >
    # gigstack API v2


    Build customer, invoice and payment integrations. Start with the
    [quickstart](https://docs.gigstack.io/quickstart), then select the [issuing
    country](https://docs.gigstack.io/concepts/shared-fields).


    ## Authentication and environments


    Use Authorization: Bearer YOUR_API_KEY. Standard live and test keys use
    https://api.gigstack.io/v2. Internal staging uses
    https://gigstack-staging-9z9nnaat.uc.gateway.dev/v2 and separate keys. Test
    mode is a data mode within an environment; a body field does not switch a
    key's mode.


    See [authentication](https://docs.gigstack.io/authentication) for key
    handling, OAuth team scope and gigstack Connect. Internal partner
    provisioning is outside this public contract; health probes have their own
    security declarations. Operations marked unavailable have no configured
    public gateway route.


    ## Read the operation contract


    Response envelopes, pagination and retry rules differ by endpoint. HTTP
    success alone does not prove external fiscal completion or movement of
    money. Reconcile ambiguous writes before retrying. Use [responses and
    recovery](https://docs.gigstack.io/responses) and the operation's error
    codes; document credits and daily limits are not generic retryable rate
    limits.


    The issuing team's configuration selects Mexico or Colombia; customer
    country and currency do not. Read
    [Mexico](https://docs.gigstack.io/countries/mexico) or
    [Colombia](https://docs.gigstack.io/countries/colombia) before choosing
    fiscal fields. Accepted public input differs from a provider's direct
    payload.


    Examples and schema checks do not imply every operation has been executed
    live. [Verification coverage](https://docs.gigstack.io/verification)
    distinguishes source review, offline checks and observed staging behavior.
    Documentation describes operations and does not authorize execution.
  version: 2.0.0
  contact:
    name: Gigstack API Support
    url: https://gigstack.io
    email: support@gigstack.io
  license:
    name: Proprietary
    url: https://gigstack.io/terms
  termsOfService: https://gigstack.io/terms
servers:
  - url: https://api.gigstack.io/v2
    description: >
      Public API for standard live and test-mode keys. Test data is isolated by
      the key mode

      (`livemode: false`). Internal staging is a separate deployment and key
      store; see

      https://docs.gigstack.io/authentication#environments for its base URL.
security:
  - bearerAuth: []
externalDocs:
  description: Complete API Documentation & Guides
  url: https://docs.gigstack.io
paths:
  /users/me:
    get:
      tags:
        - Your Account
      summary: Read your account profile
      description: >-
        Requires a verified Firebase ID token or signed, active personal MCP
        token. Team API keys and OAuth client credentials cannot act as their
        creator. Firebase callers may access their own identity before joining a
        team. MCP callers remain subject to current credential/team
        authorization. Authentication is verified in the backend, including when
        requests pass through the API gateway.
      operationId: getSelfProfile
      responses:
        '200':
          description: Persisted account state or action result.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/SelfProfile'
                  timestamp:
                    type: number
                required:
                  - success
                  - data
                  - timestamp
        '400':
          description: Invalid fields, empty patch, or invalid cursor.
        '401':
          description: A valid Firebase or personal MCP credential is required.
        '403':
          description: >-
            Disabled account, blocked membership, or insufficient account
            authority.
        '404':
          description: Resource not found within your authorized scope.
        '409':
          description: >-
            Context mismatch, changed membership, or personal token limit
            reached.
        '500':
          description: Internal failure. Reconcile current state before retrying a write.
      security:
        - bearerAuth: []
components:
  schemas:
    SelfProfile:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          nullable: true
        email_verified:
          type: boolean
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        phone:
          type: string
          nullable: true
        country:
          type: string
          nullable: true
        company_role:
          type: string
          nullable: true
        photo_url:
          type: string
          nullable: true
        providers:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              uid:
                type: string
            required:
              - id
              - uid
        created_at:
          type: string
          description: Firebase Auth creation metadata date string.
          nullable: true
        last_sign_in_at:
          type: string
          description: Firebase Auth sign-in metadata date string.
          nullable: true
        active_team_id:
          type: string
          nullable: true
        active_billing_account_id:
          type: string
          nullable: true
      required:
        - id
        - email
        - email_verified
        - first_name
        - last_name
        - phone
        - country
        - company_role
        - photo_url
        - providers
        - created_at
        - last_sign_in_at
        - active_team_id
        - active_billing_account_id
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        **Authentication Method:** HTTP Bearer token.


        The runtime requires the literal `Bearer ` prefix — a bare token in the

        `Authorization` header is rejected with `401 unauthorized`.


        **Header Format:** `Authorization: Bearer YOUR_API_KEY`


        Your API key is a JWT. Live keys operate on live data (`livemode:
        true`);

        test keys operate on isolated test data (`livemode: false`).


        **Get your key at:**
        [app.gigstack.pro/settings?tab=api](https://app.gigstack.pro/settings?tab=api)


        **Errors:** credential failures are answered by the authentication layer
        with a raw

        `{ "message": … }` body, not the standardized envelope — `401` for a
        missing, malformed or

        expired token, `403` for a revoked key or a plan without API access. See
        the `Unauthorized`

        and `AuthForbidden` responses.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.