All API resources
API reference

User

The user an API key or access token acts as, and the workspaces they belong to.

Base URL https://app.prosaic.works/api/public/v1. Every request needs an API key or access token; see the overview.

Get current user information

GET/api/public/v1/me

SDK: prosaic.me.retrieve()

Returns the authenticated user's information including their workspaces and whether they have connected bank accounts.

This endpoint is intended for the Expenses app to determine:

  • User type (accountant vs individual) based on workspace roles
  • Whether to prompt for bank account connection
  • Which workspaces/clients the user has access to

Responses

200 Successful response

  • dataobjectrequired
    Show 5 child attributes
    • idstringrequired
    • emailstringrequired
    • namestringrequirednullable
    • workspacesarray of objectsrequired
      Show 4 child attributes
      • idstringrequired
      • namestringrequired
      • rolestringrequired

        One of: client, standard_user, admin, accountant, advisor, workspace_owner

      • subscriptionStatestringrequired
    • hasConnectedBankAccountsbooleanrequired
  • metaobject
    Show 1 child attribute
    • countnumberrequired
  • 401 Unauthorized - Invalid or missing API key/token
  • 404 User not found
  • 500 Internal server error
Node SDK
const { data } = await prosaic.me.retrieve();
curl
curl https://app.prosaic.works/api/public/v1/me \
  -H "Authorization: Bearer $PROSAIC_API_KEY"