Data Board API
1. Search Board
Search for board using filters and pagination.
This API allows you to query a specific board and retrieve results based on matching strategies or limits.
Endpoint for Product:
POST https://app-gateway.imbrace.co/3rd/board_search/{board_id}/searchEndpoint for Demo:
POST https://app-gateway.demo.imbrace.co/3rd/board_search/{board_id}/searchEndpoint for Dev:
POST https://app-gateway.dev.imbrace.co/3rd/board_search/{board_id}/searchHeaders:
Content-Type:application/jsonx-access-token:Contact to iMBRACE
Query Params
Body:
Result:
Status code: 200 OK
{ "success": true, "message": { "hits": [ { "_id": "bi_e41fe9ef-fd2a-4e9b-b51e-f0a125965bb9", "doc_name": "board_items", "business_unit_id": "bu_efe00d4d-13d4-4673-a733-8a4fcf7ae144", "organization_id": "org_05994568-2a16-4550-ae73-0401a7f5bde0", "board_id": "brd_d156df21-dd75-4f2a-9c9f-8250f726bfb2", "created_type": "manual", "fields": { "6700b04e89647d90e67227f1": "Dennis Tedja", "6700b05989647d90e6722977": "Ajax X iMBrace", "6700b05889647d90e6722961": null, "6700b05789647d90e672294d": "1970-01-01T07:48:00.000Z", "6700b05689647d90e672293a": "2024-10-06T07:48:00.000Z", "6700b05689647d90e672292a": { "country_code": "HK", "country_calling_code": "852", "phone": "69709328", "calling_code_with_number": "+85269709328", "national_number": "69709328" } }, "conversation_ids": [], "public_id": "bi_e41fe9ef-fd2a-4e9b-b51e-f0a125965bb9", "created_at": "2024-10-06T07:48:31.095Z", "fields_timestamp": { "6700b05789647d90e672294d": 28080, "6700b05689647d90e672293a": 1728200880 } }, { "_id": "bi_d572a8b5-6bd6-42b1-9858-9871b6bf92f8", "doc_name": "board_items", "business_unit_id": "bu_efe00d4d-13d4-4673-a733-8a4fcf7ae144", "organization_id": "org_05994568-2a16-4550-ae73-0401a7f5bde0", "board_id": "brd_d156df21-dd75-4f2a-9c9f-8250f726bfb2", "created_type": "manual", "fields": { "6700b04e89647d90e67227f1": "Sam", "6700b05989647d90e6722977": "Sam", "6700b05889647d90e6722961": "Hello, iMBrace!", "6700b05789647d90e672294d": "1970-01-01T03:38:00.000Z", "6700b05689647d90e672293a": "2024-10-05T03:38:00.000Z", "6700b05689647d90e672292a": { "country_code": "HK", "country_calling_code": "852", "phone": "94412310", "calling_code_with_number": "+85294412310", "national_number": "94412310" } }, "conversation_ids": [], "public_id": "bi_d572a8b5-6bd6-42b1-9858-9871b6bf92f8", "created_at": "2024-10-05T03:38:39.046Z", "fields_timestamp": { "6700b05789647d90e672294d": 13080, "6700b05689647d90e672293a": 1728099480 }, "updated_at": "2024-10-05T03:38:44.649Z" }, { "_id": "bi_3aa08178-8038-4481-bd2b-f012b7d3deca", "doc_name": "board_items", "business_unit_id": "bu_efe00d4d-13d4-4673-a733-8a4fcf7ae144", "organization_id": "org_05994568-2a16-4550-ae73-0401a7f5bde0", "board_id": "brd_d156df21-dd75-4f2a-9c9f-8250f726bfb2", "created_type": "manual", "fields": { "6700b04e89647d90e67227f1": "Dennis Tedja", "6700b05989647d90e6722977": "Ajax X iMBrace", "6700b05889647d90e6722961": "News on OpenAi API and Llama new features", "6700b05789647d90e672294d": "1970-01-01T07:49:00.000Z", "6700b05689647d90e672293a": "2024-10-06T07:49:00.000Z", "6700b05689647d90e672292a": { "country_code": "HK", "country_calling_code": "852", "phone": "69709328", "calling_code_with_number": "+85269709328", "national_number": "69709328" } }, "conversation_ids": [], "public_id": "bi_3aa08178-8038-4481-bd2b-f012b7d3deca", "created_at": "2024-10-06T07:49:24.570Z", "fields_timestamp": { "6700b05789647d90e672294d": 28140, "6700b05689647d90e672293a": 1728200940 } }, { "_id": "bi_989eb95e-aa19-4b0d-b9b6-c1d8c6a590a6", "doc_name": "board_items", "business_unit_id": "bu_efe00d4d-13d4-4673-a733-8a4fcf7ae144", "organization_id": "org_05994568-2a16-4550-ae73-0401a7f5bde0", "board_id": "brd_d156df21-dd75-4f2a-9c9f-8250f726bfb2", "created_type": "manual", "fields": { "6700b04e89647d90e67227f1": "Dennis Tedja", "6700b05989647d90e6722977": "Ajax X iMBrace", "6700b05889647d90e6722961": "let me know what you thikn", "6700b05789647d90e672294d": "1970-01-01T07:49:00.000Z", "6700b05689647d90e672293a": "2024-10-06T07:49:00.000Z", "6700b05689647d90e672292a": { "country_code": "HK", "country_calling_code": "852", "phone": "69709328", "calling_code_with_number": "+85269709328", "national_number": "69709328" } }, "conversation_ids": [], "public_id": "bi_989eb95e-aa19-4b0d-b9b6-c1d8c6a590a6", "created_at": "2024-10-06T07:49:30.805Z", "fields_timestamp": { "6700b05789647d90e672294d": 28140, "6700b05689647d90e672293a": 1728200940 } } ], "query": "", "processingTimeMs": 4, "limit": 20, "offset": 0, "estimatedTotalHits": 455 } }Example:
curl --request POST \ --url https://app-gateway.dev.imbrace.co/3rd/board_search/brd_1c41d851-90f3-44b0-8b51-9628d30c29a6/search \ --header 'Authorization: Basic Og==' \ --header 'content-type: application/json' \ --header 'x-access-token: api_df0d164e-5cfe-4471-8063-f155aedb8af8' \ --data '{ "limit": 20, "matchingStrategy": "all", "offset": 0 } '
2. Create Multiple Board Items
Create multiple board items for a specific board.
This API lets you create one or many items in a board by passing field values per item.
Endpoint for Product:
POST https://app-gateway.imbrace.co/3rd/boards/create/{board_id}/board_itemsEndpoint for Demo:
POST https://app-gateway.demo.imbrace.co/3rd/boards/create/{board_id}/board_itemsEndpoint for Dev:
POST https://app-gateway.dev.imbrace.co/3rd/boards/create/{board_id}/board_itemsHeaders:
Content-Type:application/jsonx-access-token:Contact to iMBRACE
Query Params
(none)
Body:
Result:
Status code: 200 OK
Example:
3. Delete Board Items
Delete one or more board items from a specific board.
This API allows you to remove multiple board items at once by passing their unique IDs.
Endpoint for Product:
POST https://app-gateway.imbrace.co/3rd/boards/delete/{board_id}/board_itemsEndpoint for Demo:
POST https://app-gateway.demo.imbrace.co/3rd/boards/delete/{board_id}/board_itemsEndpoint for Dev:
POST https://app-gateway.dev.imbrace.co/3rd/boards/delete/{board_id}/board_itemsHeaders:
Content-Type:application/jsonx-access-token:Contact to iMBRACE
Query Params
(none)
Body:
Result:
Status code: 200 OK
Example:
4. Upload File
Upload a file to the board system.
This API allows you to upload files using multipart/form-data format.
Endpoint for Product:
POST https://app-gateway.imbrace.co/3rd/boards/uploadEndpoint for Demo:
POST https://app-gateway.demo.imbrace.co/3rd/boards/uploadEndpoint for Dev:
POST https://app-gateway.dev.imbrace.co/3rd/boards/uploadHeaders:
x-access-token:Contact to iMBRACE
Query Params
(none)
Body:
Form-data with file attachment
Result:
Status code: 200 OK
Example:
5. Update Multiple Board Items
Update multiple board items for a specific board.
This API allows you to update existing board items by specifying their IDs and the field values to modify.
Endpoint for Product:
PUT https://app-gateway.imbrace.co/3rd/boards/update/{board_id}/board_itemsEndpoint for Demo:
PUT https://app-gateway.demo.imbrace.co/3rd/boards/update/{board_id}/board_itemsEndpoint for Dev:
PUT https://app-gateway.dev.imbrace.co/3rd/boards/update/{board_id}/board_itemsHeaders:
Content-Type:application/jsonx-access-token:Contact to iMBRACE
Query Params
(none)
Body:
Result:
Status code: 200 OK
Example:
6. List All Boards
Retrieve a list of all available boards.
This API allows you to fetch all boards that the authenticated user has access to.
Endpoint for Product:
GET https://app-gateway.imbrace.co/3rd/boardsEndpoint for Demo:
GET https://app-gateway.demo.imbrace.co/3rd/boardsEndpoint for Dev:
GET https://app-gateway.dev.imbrace.co/3rd/boardsHeaders:
Content-Type:application/jsonx-access-token:Contact to iMBRACEaccept:application/json, text/plain, */*accept-language:en-US,en;q=0.9,vi;q=0.8
Query Params
(none)
Result:
Status code: 200 OK
Example:
7. Get Board Items
Retrieve a list of all items for a specific board.
This API allows you to fetch all the items associated with a particular board by its ID.
Endpoint for Product:
GET https://app-gateway.imbrace.co/3rd/boards/{board_id}/board_itemsEndpoint for Demo:
GET https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}/board_itemsEndpoint for Dev:
GET https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}/board_itemsHeaders:
Content-Type:application/jsonx-access-token:Contact to iMBRACE
Path Parameters
board_id: The unique identifier of the board (e.g.,brd_1c41d851-90f3-44b0-8b51-9628d30c29a6)
Query Params
(none)
Result:
Status code: 200 OK
Example:
8. Get Board Item Detail
Retrieve detailed information about a specific board item.
This API allows you to fetch the complete details of a specific item within a board using its unique identifier.
Endpoint for Product:
GET https://app-gateway.imbrace.co/3rd/boards/{board_id}/board_items/{item_id}Endpoint for Demo:
GET https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}/board_items/{item_id}Endpoint for Dev:
GET https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}/board_items/{item_id}Headers:
Content-Type:application/jsonx-access-token:Contact to iMBRACE
Path Parameters
board_id: The unique identifier of the board (e.g.,brd_1c41d851-90f3-44b0-8b51-9628d30c29a6)item_id: The unique identifier of the board item (e.g.,bi_e2513c1e-62d7-4cb0-a0d2-3b10c3dd3423)
Query Params
(none)
Result:
Status code: 200 OK
Example:
9. Export Board as CSV
Retrieve and export board data as a downloadable CSV file.
This API allows you to export all board items and their associated field data from a specific board into a CSV format. It can be used for reporting, data analysis, or backup purposes.
Endpoint for Product:
GET https://app-gateway.imbrace.co/3rd/boards/{board_id}/export_csvEndpoint for Demo:
GET https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}/export_csvEndpoint for Dev:
GET https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}/export_csvHeaders:
x-access-token:Contact to iMBRACEContent-Type:application/json
Path Parameters
board_id: The unique identifier of the board (e.g.,brd_1c41d851-90f3-44b0-8b51-9628d30c29a6)item_id: The unique identifier of the board item (e.g.,bi_e2513c1e-62d7-4cb0-a0d2-3b10c3dd3423)
Query Params
(none)
Result:
Status code: 200 OK
Content-Type:
text/csvBody Example (truncated):
Example:
10. Export Board Items
Retrieve and export board items.
This API allows you to export all board items from a specific board.
Endpoint for Product:
GET https://app-gateway.imbrace.co/3rd/boards/{board_id}/export_board_itemsEndpoint for Demo:
GET https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}/export_board_itemsEndpoint for Dev:
GET https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}/export_board_itemsHeaders:
x-access-token:Contact to iMBRACEContent-Type:multipart/form-data
Path Parameters
board_id: The unique identifier of the board (e.g.,brd_1c41d851-90f3-44b0-8b51-9628d30c29a6)
Query Params
(none)
Result:
Status code: 200 OK
Example:
11. Update Board
Update an existing board's information.
This API allows you to update the name, description, and team associations of a specific board.
Endpoint for Product:
PUT https://app-gateway.imbrace.co/3rd/boards/{board_id}Endpoint for Demo:
PUT https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}Endpoint for Dev:
PUT https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}Headers:
x-access-token:Contact to iMBRACEContent-Type:application/json
Path Parameters
board_id: The unique identifier of the board (e.g.,brd_1c41d851-90f3-44b0-8b51-9628d30c29a6)
Request Body (JSON)
Result:
Status code: 200 OK
Example:
12. Add Multiple Board Fields
Add multiple custom fields to an existing board in a single operation.
This API allows you to add multiple custom fields to a specific board at once, supporting various field types like ShortText, Number, and other data types.
Endpoint for Product:
PUT https://app-gateway.imbrace.co/3rd/boards/{board_id}/multiple_board_fieldsEndpoint for Demo:
PUT https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}/multiple_board_fieldsEndpoint for Dev:
PUT https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}/multiple_board_fieldsHeaders:
x-access-token:Contact to iMBRACEContent-Type:application/json
Path Parameters
board_id: The unique identifier of the board (e.g.,brd_5316485d-a155-4e4e-bc6b-958af5cfa47b)
Request Body (JSON)
Result:
Status code: 200 OK
Example:
13. Delete Board
Permanently delete a board and all its associated data.
This API allows you to delete a specific board by its ID. This action cannot be undone.
Endpoint for Product:
DELETE https://app-gateway.imbrace.co/3rd/boards/{board_id}Endpoint for Demo:
DELETE https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}Endpoint for Dev:
DELETE https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}Headers:
x-access-token:Contact to iMBRACEContent-Type:application/json
Path Parameters
board_id: The unique identifier of the board to delete (e.g.,brd_f82a6316-a854-4e2b-9394-b12ff50022a0)
Result:
Status code: 200 OK
Example:
14. Delete Board Item
Permanently delete a specific board item from a board.
This API allows you to delete a specific board item by its ID from a specific board. This action cannot be undone.
Endpoint for Product:
DELETE https://app-gateway.imbrace.co/3rd/boards/{board_id}/board_items/{item_id}Endpoint for Demo:
DELETE https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}/board_items/{item_id}Endpoint for Dev:
DELETE https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}/board_items/{item_id}Headers:
x-access-token:Contact to iMBRACEContent-Type:application/json
Path Parameters
board_id: The unique identifier of the board containing the item (e.g.,brd_5316485d-a155-4e4e-bc6b-958af5cfa47b)item_id: The unique identifier of the board item to delete (e.g.,bi_88620293-9920-42cd-ac44-58f682b7919c)
Result:
Status code: 200 OK
Example:
15. Import CSV
Import data from a CSV file into a specific board.
This API allows you to import data from a CSV file by providing the file URL and field mappings to create board items automatically.
Endpoint for Product:
POST https://app-gateway.imbrace.co/3rd/boards/{board_id}/import_csvEndpoint for Demo:
POST https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}/import_csvEndpoint for Dev:
POST https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}/import_csvHeaders:
x-access-token:Contact to iMBRACEContent-Type:application/json
Path Parameters
board_id: The unique identifier of the board (e.g.,brd_5316485d-a155-4e4e-bc6b-958af5cfa47b)
Request Body (JSON)
Result:
Status code: 200 OK
Example:
16. Import Exported Board Items
Import data from an exported CSV file into a specific board.
This API allows you to import data from a previously exported CSV file by providing the file URL and field mappings to create board items automatically.
Endpoint for Product:
POST https://app-gateway.imbrace.co/3rd/boards/{board_id}/import_exported_board_itemsEndpoint for Demo:
POST https://app-gateway.demo.imbrace.co/3rd/boards/{board_id}/import_exported_board_itemsEndpoint for Dev:
POST https://app-gateway.dev.imbrace.co/3rd/boards/{board_id}/import_exported_board_itemsHeaders:
x-access-token:Contact to iMBRACEContent-Type:application/json
Path Parameters
board_id: The unique identifier of the board (e.g.,brd_5316485d-a155-4e4e-bc6b-958af5cfa47b)
Request Body (JSON)
Result:
Status code: 200 OK
Example:
17. Upload File (Alternative)
Upload a file to the board system using form-data format.
This API allows you to upload files using multipart/form-data format with a different endpoint structure.
Endpoint for Product:
POST https://app-gateway.imbrace.co/3rd/boards/uploadEndpoint for Demo:
POST https://app-gateway.demo.imbrace.co/3rd/boards/uploadEndpoint for Dev:
POST https://app-gateway.dev.imbrace.co/3rd/boards/uploadHeaders:
x-access-token:Contact to iMBRACE
Query Params
(none)
Body:
Form-data with file attachment
Result:
Status code: 200 OK
Example:
Note: Please use postman to test this API.
18. File Upload (Alternative Endpoint)
Upload a file to the board system and get a public URL using an alternative endpoint.
This API allows you to upload files using multipart/form-data format and returns a public URL that can be used to access the uploaded file.
Endpoint for Product:
POST https://app-gateway.imbrace.co/3rd/boards/_fileuploadEndpoint for Demo:
POST https://app-gateway.demo.imbrace.co/3rd/boards/_fileuploadEndpoint for Dev:
POST https://app-gateway.dev.imbrace.co/3rd/boards/_fileuploadHeaders:
x-access-token:Contact to iMBRACE
Request Body (Form Data)
file: The file to upload (binary data)
Result:
Status code: 200 OK
Example:
Note: Please use postman to test this API.
Last updated