Skip to main content

1. List credentials

When the user clicks the "My Collectors" button in your app, he should see:

  • A list of all their configured credentials.
  • The current status of each collector (active, error, needs authentication, etc...).
  • Basic information about each collector (supplier name, account identifier).
  • Options to manage their credentials (view, re-connect and delete).

Here is an example of what the table displayed on your frontend could look like:


SupplierStatusCreation dateLast CollectNext CollectDocuments collectedActions
Amazon BusinessActive2025-10-012025-11-142025-11-1646Delete
Google WorkspaceIn Progress2025-12-15-2025-12-150
Office DepotError - Wrong password2025-11-052025-11-05-0Delete
OpenAIDisconnected2025-08-212025-10-30-21

Implementation

StepSideDescription
1FrontendUser clicks on the My Collectors button.
2BackendUpsert the user in our database using the POST /user endpoint and get the user id
3BackendUse the user id to get the users credentials with the endpoint GET /user/{user_id}/credentials.
4FrontendRender the credentials on your frontend in a nice table. See recommended table above.

Display actions depending on the collector state

When getting the credentials with the endpoint GET /user/{user_id}/credentials, you will see that each credential has a field called state. Actions displayed in the table depends on the state.index value. See Credential state for more infos.

How it works