API Reference
DocumentationChangelogConsoleWebsite
  • API Guides
  • Overview
    • API design
    • Errors
    • Webview
    • Fair usage policy
    • Authentication
  • USER CONNECTIONS
    • Users
    • Connectors
    • Connections
  • PRODUCTS
    • DATA AGGREGATION
      • Bank accounts
      • Bank transactions
      • Transactions attachments
      • Categorization
      • Bank account types
      • Balances
      • Currencies
      • Account Ownerships
      • Identities (obsolete)
      • Categories (obsolete)
      • Invoices
      • Credit notes
      • Advisory (obsolete)
      • Indicators
    • WEALTH AGGREGATION
      • Investments
      • Market orders
      • Pockets
      • Loan amortizations
    • DOCUMENTS AGGREGATION
      • Subscriptions
      • Documents
      • Document types
      • Connection Identity
    • PAYMENTS
      • Payments
      • Payment Links
      • Transfers (obsolete)
  • API SETUP
    • Configuration
    • Client applications
Powered by GitBook
On this page
  • API endpoints
  • Users management
  • List users
  • Get a user
  • Delete a user
  • Webhooks
  • User created
  • User deleted
  • User synced (deprecated)
  • Data model
  • UsersList object
  • User object

Was this helpful?

  1. USER CONNECTIONS

Users

Users represent the top-level isolation level of synchronized data. They are intended to be actively managed by clients to mirror their own end-user definition.

PreviousAuthenticationNextConnectors

Last updated 1 year ago

Was this helpful?

API endpoints

Users management

List users

GET https://{domain}.biapi.pro/2.0/users

List all users of the domain.

The endpoint requires with a users token. The users token is only available in the Settings section of the .

Response body: UsersList object

Get a user

GET https://{domain}.biapi.pro/2.0/users/{userId}

Get a single user by ID.

The endpoint requires with a user token

Path Parameters

Name
Type
Description

userId

Integer or "me"

ID of the user.

Response body: User object

Delete a user

DELETE https://{domain}.biapi.pro/2.0/users/{userId}

Delete a user by ID.

Path Parameters

Name
Type
Description

userId

Integer or "me"

ID of the user.

Webhooks

User created

A USER_CREATED wehbook is emitted after a permanent user is created.

Webhook request: User object

User deleted

A USER_DELETED wehbook is emitted after a user is deleted.

Webhook request: User object

User synced (deprecated)

Webhook request:

Property
Type
Description

user

The user related to the sync.

connections

List of connections.

connections[].connector

On each connections item, the connector associated with the connection.

connections[].sources

Array of ConnectionSource objects

On each connections item, the activated connections sources that were synced.

connections[].accounts

On each connections item, the activated bank accounts sources that were synced.

connections[].accounts[].transactions

On each accounts item, the new transactions that were found.

Data model

UsersList object

Property
Type
Description

users

List of users.

User object

Property
Type
Description

id

Integer

ID of the user.

signin

DateTime

The endpoint requires with a user token

A USER_SYNCED webhook is emitted after multiple connections of a user have been synced. This webhook is deprecated for multiple connections per user, prefer usage of .

object

Array of objects

object

Array of objects

Array of objects

Array of objects

header authentication
console
header authentication
header authentication
CONNECTION_SYNCED
User
User
BankAccount
Connector
Transaction
Connection