API access issue – API key & environment configuration

Help me!
1

Feature(s) impacted

I’m reaching out because we are trying to query Forest Admin through the API. Our Tech Lead has run several tests without success so far.

More specifically, we need to be able to configure and use the following parameters:

FOREST_API_KEY=
FOREST_ENV_ID=
FOREST_API_URL=

Could you help us with this, or point us to the appropriate support or documentation?

Thank you in advance for your help.

Context

  • Project name: sponsoplus-admin
  • Team name: Operations
2

Hello,

Thanks for reaching out.

To help you effectively, could you please provide a bit more context about your use case?
Specifically, what are you trying to achieve with the Forest Admin API?

Once we better understand your needs, we’ll be able to guide you to the appropriate configuration or documentation.

Thanks in advance for the additional details.

Best regards,
Alban

3

Hello Alban,
Thanks for getting back to me.
Use case: We need to programmatically sync data from Forest Admin to our internal database.
What we need:
Correct API endpoint and authentication method for reading collections
Numeric Environment ID (if needed)
Documentation for listing/filtering users via API
Thanks

4

Hello Maxime,

Thanks for reaching out!

To be able to guide you most efficiently: what’s the data you want to sync?

You’re mentioning users: is it a collection or the Forest Admin users?

To give more details:

Forest Admin doesn’t store your data. The data displayed in Forest Admin is in your technical stack (either database, or SaaS, or whatever customization implemented on your end).

The only data we store is the usage data. You can use our public API to retrieve logs and notes.

Gautier

VP Product & Customer Experience

5

Hello, I am working with Maxime and I would like to clarify something. The collections we want to access (in read-only mode) are not Forest Admin’s internal collections, but our own business data. Is there a solution to automatically read and export the data displayed in Forest Admin without requiring direct access to the source databases?

6

Hello Antoine! Nice to meet you :slight_smile:

This is not natively possible right now. We are currently working on it, it should be available soon to users on our most recent agent.

Nevertheless, you could reverse-engineer it using the routes exposed by your (legacy) agent to do so. We haven’t documented it and don’t often recommend it, but if this is what you’re looking for, you can find those routes directly within your agent.

We’ll make sure to keep you posted when we’ll release this product evolution.

Thank you,
Gautier