> ## Documentation Index > Fetch the complete documentation index at: https://help.privy.com/llms.txt > Use this file to discover all available pages before exploring further. # Get account > Retrieve information about the Privy account associated with the API token. The identity read: who the token belongs to, and which subaccounts it can reach. Each subaccount `id` is the `Privy-Account-Id` value that points every other endpoint at that subaccount. Nothing else is here — audit configuration with `/v1/account/setup` and read results from `/v1/reports/summary`. No scope is required — any valid bearer token can call this endpoint. ## OpenAPI ````yaml openapi/privy-api.yaml GET /account openapi: 3.1.0 info: title: Privy API version: '1.0' description: > The Privy API lets you programmatically manage your contact list and read what you have set up in Privy. Create, update, unsubscribe, and remove contacts; report orders; and read your campaigns, flows, segments, orders, store products, coupon pools, performance reports, and account setup. servers: - url: https://api.privy.com/v1 description: Production security: - bearerAuth: [] tags: - name: Account description: Retrieve information about the authenticated Privy account. - name: Contacts description: Manage your contact list. - name: Imports description: >- Read your contact import history — CSV uploads, connected-provider syncs, and SMS consent imports. - name: Campaigns description: >- Read your message campaigns — email and SMS newsletters, plus the messages your flows send. - name: Displays description: >- Read your on-site displays (popups, flyouts, banners, embedded forms, landing pages). - name: Coupons description: Read your coupon pools, their code inventory, and individual codes. - name: Reports description: >- Read performance reporting — signups, views, conversion rates, and attributed revenue — for your business, displays, and flows. - name: Flows description: Read your automation flows and their configuration. - name: Segments description: Read your customer segments and their membership. - name: Orders description: Report orders placed in your store and read your order history. - name: Products description: Read the product catalog and collections of your connected store. - name: Events description: Ingest custom events to trigger Flows and other automations. paths: /account: get: tags: - Account summary: Get account description: > Retrieve information about the Privy account associated with the API token. The identity read: who the token belongs to, and which subaccounts it can reach. Each subaccount `id` is the `Privy-Account-Id` value that points every other endpoint at that subaccount. Nothing else is here — audit configuration with `/v1/account/setup` and read results from `/v1/reports/summary`. No scope is required — any valid bearer token can call this endpoint. operationId: getAccount parameters: - $ref: '#/components/parameters/AccountIdParam' responses: '200': description: The authenticated Privy account. content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/Account' example: data: id: A1B2C3D4E5F6G7H8I9J0K1L2 name: My Store url: https://mystore.com subaccounts: - id: S1U2B3A4C5C6T7 name: My Store — Canada url: https://ca.mystore.com '401': $ref: '#/components/responses/Unauthorized' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: parameters: AccountIdParam: name: Privy-Account-Id in: header required: false description: > Target a subaccount instead of the main connected account. Pass a subaccount `id` from get_account's `subaccounts` list. Only direct subaccounts of the connected account are reachable — omit this for the main account itself. schema: type: string example: S1U2B3A4C5C6T7 schemas: Account: type: object properties: id: type: string description: Stable, unique identifier for the Privy account. example: A1B2C3D4E5F6G7H8I9J0K1L2 name: type: - string - 'null' description: >- Display name of the Privy account. `null` if the account has not configured a name. example: My Store url: type: - string - 'null' description: >- Primary website URL for the account. `null` if the account has not configured an URL. example: https://mystore.com subaccounts: type: array description: > Subaccounts of this account that the presented credential can access. Each `id` is the value to send in the `Privy-Account-Id` header to make requests on that subaccount's behalf. The list is credential-scoped: API tokens list the subaccounts covered by their subaccount-access grant; OAuth tokens (which have no subaccount access mechanism) and requests already targeting a subaccount get an empty list. items: $ref: '#/components/schemas/Subaccount' Subaccount: type: object properties: id: type: string description: >- The subaccount's identifier — usable as the `Privy-Account-Id` header value. example: S1U2B3A4C5C6T7 name: type: - string - 'null' example: My Store — Canada url: type: - string - 'null' example: https://ca.mystore.com ErrorResponse: type: object properties: error: type: object required: - code - message properties: code: type: string enum: - invalid_client - invalid_scope - unauthorized - insufficient_scope - paid_plan_required - api_access_required - not_found - no_connected_store - conflict - contacts_not_ready - validation_failed - rate_limited - store_unavailable example: validation_failed message: type: string example: One or more fields are invalid details: type: array items: type: object properties: field: type: string example: email message: type: string example: is required responses: Unauthorized: description: Missing or invalid bearer token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: unauthorized message: Bearer token is missing or invalid RateLimited: description: Rate limit exceeded. Retry after the specified time. headers: Retry-After: description: Seconds to wait before retrying. schema: type: integer example: 42 X-RateLimit-Limit-Minute: description: Maximum requests allowed per minute. schema: type: integer example: 60 X-RateLimit-Remaining-Minute: description: Requests remaining in the current minute window. schema: type: integer example: 0 X-RateLimit-Reset-Minute: description: Unix timestamp when the minute window resets. schema: type: integer example: 1711929600 X-RateLimit-Limit-Day: description: Maximum requests allowed per day. schema: type: integer example: 10000 X-RateLimit-Remaining-Day: description: Requests remaining in the current day window. schema: type: integer example: 9500 X-RateLimit-Reset-Day: description: Unix timestamp when the day window resets. schema: type: integer example: 1712016000 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: rate_limited message: Rate limit exceeded securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API token or OAuth access token description: > Send either an API token or an OAuth access token as `Authorization: Bearer `. See the Authentication page for details. ````