API REFERENCE

Get Account

On this page

GET/api/accounts/{id}

Retrieve detailed account information by ID. Returns the account with associated profile info, emails, and wallet addresses.

Authentication

See the authentication guide for API key and account access requirements.

Request

cURL

curl --request GET \
  --url 'https://api.recoupable.dev/api/accounts/YOUR_ID' \
  --header 'x-api-key: YOUR_API_KEY'

Replace the YOUR_ placeholders with your values. Required query parameters are included; optional parameters are listed below.

Parameters

Path parameters

idstringrequired

The unique identifier (UUID) of the account

Responses

200Account retrieved successfully

application/json

statusstring · enumrequired

Status of the request

Values: "success"

accountobjectrequired

The account details

Properties

idstring

Unique identifier for the account

format: uuid

namestring

Account display name

imagestringnullable

Profile image URL

instructionstringnullable

Custom AI instructions for this account

knowledgesarray<Knowledge>nullable

Knowledge base files attached to this account

Item properties

urlstring

URL to the knowledge file

namestring

Name of the knowledge file

typestring

MIME type of the file

emailstringnullable

Primary email address

wallet_addressstringnullable

Connected wallet address

404Account not found

application/json

statusstring · enumrequired

Status of the request

Values: "error"

messagestringrequired

Error message describing what went wrong

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download accounts.json

View operation source

json

{
  "description": "Retrieve detailed account information by ID. Returns the account with associated profile info, emails, and wallet addresses.",
  "parameters": [
    {
      "name": "id",
      "in": "path",
      "description": "The unique identifier (UUID) of the account",
      "required": true,
      "schema": {
        "type": "string",
        "format": "uuid"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Account retrieved successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/GetAccountResponse"
          }
        }
      }
    },
    "404": {
      "description": "Account not found",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AccountErrorResponse"
          }
        }
      }
    }
  }
}