Retrieve Braineet data in JSON

You can retrieve data from your Braineet Crowdsourcing platform using our public export APIs. These endpoints allow you to extract platform data in JSON format for use in analytics, reporting, or integration with other tools.

To retrieve data from Braineet, you can utilize the Data URL endpoint and choose Basic authentication.

Base URL

Your API base URL is:

https://<your-subdomain>.<your-root-domain>/api/exports/

For example, if your platform URL is https://ideas.braineet.com , then:

• platform = ideas
• platformDomain = braineet.com

If you're using a custom domain like ideas.yourcompany.com , then:

• platform = ideas
• platformDomain = yourcompany.com

Authentication

All export endpoints are protected with Basic Authentication. You will need a valid username and password to access the API.

🔐 How to Request Your Credentials

To request your API username and password:

• Email: [email protected]
• Or contact: Your Braineet Customer Success Manager (CSM)

Be sure to include your platform URL and the purpose of the access in your request.

Basic authentication is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization  header that contains the word Basic  word followed by a space and a base64-encoded string username:password . For example, to authorize as pierre.gourlaouen / APIKEYCODE123  the client would send

Authorization: Basic cGllcnJlLmdvdXJsYW91ZW5AYnJhaW5lZXQuY29tOkFQSUtFWUNPREUxMjM=

Note: Because base64 is easily decoded, Basic authentication should only be used together with other security mechanisms such as HTTPS/SSL.

Common Query Parameters

All endpoints support the following parameters:

API Specifications

When retrieving data from Braineet in JSON format, the data is structured as follows:

• JSON: An array of objects.
• Each object is a map[string]any , where:
  • Each key is the name of a custom field.
  • The value depends on the custom field type and can be:
    • A number (e.g., 42 ).
    • A string (e.g., "Some text" ).
    • An array of strings (if the custom field type supports multiple values, e.g., ["Option A", "Option B"] ).

[
  {
    "project_name": "New Marketing Initiative",
    "start_date": "2025-02-01",
    "budget": 50000,
    "tags": ["marketing", "sales"]
  },
  {
    "project_name": "Website Redesign",
    "start_date": "2025-04-10",
    "budget": 75000,
    "tags": ["design", "web"]
  }
]

Available Endpoints

You can retrieve the following resources:

Only new or updated contents

You can also use the since query parameter to retrieve only new or updated contents since a specific date and time. It uses the same ISO 8601 format:

?since=2025-03-08T00:00:00Z

• Only the fields that have been newly created or updated since this timestamp will be returned with their current values.
• If a field has not been modified, its value will appear as null (or nil in certain representations) in the returned JSON. This lets you know the field was not changed during this period.

Example Response with since

[
  {
    "project_id": 123,
    "project_name": null,
    "budget": 60000,
    "tags": null
  },
  {
    "project_id": 456,
    "project_name": "Updated Website Redesign",
    "budget": null,
    "tags": ["design", "web", "UX"]
  }
]

In this example:

• For the project with project_id : 123, only the budget field was modified. All other fields are null because they remain unchanged.
• For the project with project_id : 456, the project_name and tags were modified, while budget remains unchanged.

Example Request

Get the first 200 ideas from your platform:

GET https://team-preprod.braineet.com/api/exports/contents?page=1&limit=200&platform=ideas&platformDomain=braineet.com

Filter by date and sort ascending:

GET https://ideas.yourcompany.com/api/exports/comments?page=1&limit=200&since=2025-01-01T00:00:00Z&orderBy=ASC&platform=ideas&platformDomain=yourcompany.com

Notes

• Responses are returned in JSON format.
• Pagination is required for large datasets. Use page to access additional results.
• The since parameter is ideal for incremental exports.