PRprivy
Account

Get account

Changed on

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.

get/account

Request

  • Base URL
    https://api.privy.com/v1
  • Auth
    HTTP bearer

Headers

Privy-Account-Idstring

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.

Response

The authenticated Privy account.

Example response

{
  "data": {
    "id": "A1B2C3D4E5F6G7H8I9J0K1L2",
    "name": "My Store",
    "url": "https://mystore.com",
    "subaccounts": [
      {
        "id": "S1U2B3A4C5C6T7",
        "name": "My Store — Canada",
        "url": "https://ca.mystore.com"
      }
    ]
  }
}

Changes

  • cf0885e90d5aRevision changes
    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new forbidden enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

    • warning

      added the new segment_builder_required enum value to the / response property for the response status

  • fe500ab59b3bRevision changes
    • info

      endpoint added