Databoard API docs

Get started using our API in <5 minutes.

Articles

/api/article/create

create an article

['post']

post method

curl -X 'POST' -d '{"title": "sample title", "body": "string", "tags": ["test"], "organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/article/create

successful response, 201

error response, ['401', '500']

/api/article/delete

delete an article

['delete']

delete method

curl -X 'DELETE' -d '{"article_id": "7730e81b-21d7-4f7f-9149-fd8e50adfc1b"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/article/delete

successful response, 204

error response, ['401', '500']

/api/article/edit

edit an article

['put']

put method

curl -X 'PUT' -d '{"title": "sample title", "body": "string", "article_id": "f3139f8e-38bc-41d4-b93b-d62725e6322b", "status": "private"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/article/edit

successful response, 204

error response, ['401', '500']

/api/article/view

view an article

['post']

post method

curl -X 'POST' -d '{"article_id": "09d165e5-3831-4bb4-a852-83b1945a8ff6"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/article/view

successful response, 200

error response, ['401', '500']

/api/articles

get all existing articles

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/articles

successful response, 200

error response, ['401', '500']

▦ Datasets

/api/dataset/create

create a dataset

['post']

post method

curl -X 'POST' -d '{"organization_id": "", "survey_id": "a2ff33c6-47de-410f-8fdd-7c784f9ac96d", "schema_id": "a663a2c4-2ebb-4b0f-8aae-b87d9d14db05", "dataset_name": "Test dataset", "dataset_description": "Test dataset description", "dataset_size": 5.0, "dataset_format": ".zip", "dataset_status": "private", "license_type": "Databoard Standard License", "encrypt_setting": true, "survey_create": false}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/dataset/create

successful response, 201

error response, ['401', '500']

/api/dataset/delete

delete a dataset

['delete']

delete method

curl -X 'DELETE' -d '{"dataset_id": "ad8517ae-122e-4706-8bc8-1ef6578cb7b0"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/dataset/delete

successful response, 204

error response, ['401', '500']

/api/dataset/download

download a dataset

['post']

post method

curl -X 'POST' '{{session['base_url']}}/api/dataset/download' -d '{"dataset_id": "0468b2b1-4d0b-4ccb-a92b-7adc0f3f61bd"}' -H 'accept: */*' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' -k --output dataset.zip

successful response, 201

error response, ['500']

Flags

/api/flag/create

create a flag

['post']

post method

curl -X 'POST' -d '{"category": "string", "description": "this is a sample description", "source_id": "c6f1c698-52c1-463f-ba97-4b0437ca1c62", "source_type": "string", "organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/flag/create

successful response, 201

error response, ['400', '500']

/api/flag/delete

delete a flag

['delete']

delete method

curl -X 'DELETE' -d '{"flag_id": "92319e78-bfd2-4ab2-b7a0-4bbac3760a44"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/flag/delete

successful response, 204

error response, ['401', '500']

/api/flags

get all existing flags

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/flags

successful response, 200

error response, ['401', '500']

Follows

/api/follow/create

create a follow

['post']

post method

curl -X 'POST' -d '{"organization_id": "", "follow_id": "cc2b981d-1c77-432f-a2da-1de61d7505e9", "source_type": "string"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/follow/create

successful response, 201

error response, ['401', '500']

/api/follow/delete

delete a follow

['delete']

delete method

curl -X 'DELETE' -d '{"organization_id": "", "follow_id": "83e04cce-c95b-48e9-bd05-d789aa7badf4", "source_type": "string"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/follow/delete

successful response, 204

error response, ['401', '500']

/api/follow/read

read a follow

['post']

post method

curl -X 'POST' -d '{"user_id": "3a68075b-627c-4e50-a56f-d23a0724df18", "organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/follow/read

successful response, 200

error response, ['404', '500']

Messages

/api/message/create

create an message

['post']

post method

curl -X 'POST' -d '{"receive_id": "d950e82f-9580-43c2-af5e-66e585c6fe53", "source_type": "string", "title": "sample title", "message": "string", "organization_id": "", "thread_id": "5d72d924-15d0-4048-8b6d-a38005b8787a"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/message/create

successful response, 201

error response, ['401', '500']

/api/message/delete

delete an message

['delete']

delete method

curl -X 'DELETE' -d '{"message_id": "77326179-d724-48f1-9272-a3fb19c761d8", "thread_id": "86952118-a9b9-4efe-95ae-094bfb23475f"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/message/delete

successful response, 204

error response, ['401', '500']

/api/message/edit

edit an message

['put']

put method

curl -X 'PUT' -d '{"message_id": "2600f3a1-a602-4faf-bedb-103337ee9752", "thread_id": "966c9f01-e7eb-4135-b678-25c0e028f6c6", "message": "string", "title": "sample title"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/message/edit

successful response, 204

error response, ['401', '500']

/api/message/threads

get all existing threads

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/message/threads

successful response, 200

error response, ['401', '500']

Notifications

/api/notification/create

create a notification

['post']

post method

curl -X 'POST' -d '{"notify_message": "string", "organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/notification/create

successful response, 201

error response, ['401', '500']

/api/notification/delete

delete a notification

['delete']

delete method

curl -X 'DELETE' -d '{"notification_id": "d798422d-1db0-46af-8440-f87062976391"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/notification/delete

successful response, 204

error response, ['401', '500']

/api/notification/read

read a notification

['post']

post method

curl -X 'POST' -d '{"notification_id": "7dd59f15-9741-4379-abfb-6ee667bec1ed"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/notification/read

successful response, 200

error response, ['401', '500']

/api/notifications/get

get a notifications

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/notifications/get

successful response, 200

error response, ['401', '500']

/api/notifications/read

read a notifications

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/notifications/read

successful response, 200

error response, ['401', '500']

Organizations

/api/organization/create

create a organization

['post']

post method

curl -X 'POST' -d '{"org_name": "sample_name", "description": "this is a sample description", "size": "string", "status": "private", "license_type": "Databoard Standard License"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/organization/create

successful response, 201

error response, ['400', '500']

/api/organization/delete

delete a organization

['delete']

delete method

curl -X 'DELETE' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/organization/delete

successful response, 204

error response, ['401', '500']

/api/organization/edit

edit a organization

['put']

put method

curl -X 'PUT' -d '{"organization_id": "", "organization_name": "sample_name", "organization_description": "this is a sample description", "organization_status": "private", "organization_size": "0-10 employees", "orgnaization_default_license": "Databoard Standard License", "orgnaization_logo_url": "string"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/organization/edit

successful response, 204

error response, ['401', '500']

/api/organization/read

read a organization

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/organization/read

successful response, 200

error response, ['401', '500']

/api/organization/user/edit

edit a user

['put']

put method

curl -X 'PUT' -d '{"organization_id": "", "user_id": "1d5a6c9b-1914-4368-9e21-ebc2a1943108", "new_role": "string"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/organization/user/edit

successful response, 204

error response, ['400', '500']

/api/organization/user/remove

remove a user

['delete']

delete method

curl -X 'DELETE' -d '{"organization_id": "", "user_id": "a9ba804c-0276-4e14-90cd-6cde4df275a4"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/organization/user/remove

successful response, 200

error response, ['401', '500']

Others

/api/payment/config

config a payment

['get']

get method

curl -X 'GET' -d '{}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/payment/config

successful response, 200

error response, ['422', '500']

/api/version

version an api

['get']

get method

curl -X 'GET' -d '{}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/version

successful response, 200

error response, ['422', '500']

Requests

/api/request/create

create a request

['post']

post method

curl -X 'POST' -d '{"request_id": "a8af9962-e79c-4f19-a0ac-1737fe2e21c5", "target_id": "ac253bc9-a018-4520-bced-bc20379665b6", "request_type": "string", "request_source": "string", "target_source": "string", "message": "string"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/request/create

successful response, 201

error response, ['400', '500']

/api/request/delete

delete a request

['delete']

delete method

curl -X 'DELETE' -d '{"request_id": "cf3bc132-1f01-41c4-8a30-276e94ab90ef"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/request/delete

successful response, 204

error response, ['401', '500']

/api/request/edit

edit a request

['put']

put method

curl -X 'PUT' -d '{"request_id": "1e96d985-34cd-407c-adfd-76c5697fd3a2", "request_new_status": "private"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/request/edit

successful response, 204

error response, ['400', '500']

/api/requests/get

get a requests

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/requests/get

successful response, 200

error response, ['401', '500']

Schemas

/api/schema/create

create an schema

['post']

post method

curl -X 'POST' -d '{"json_schema": "{\"schema\": {\"test\": \"integer\", \"user\": \"string\", \"price\": \"float\"}}", "name": "test schema", "description": "test description", "status": "private", "organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/schema/create

successful response, 201

error response, ['400', '500']

/api/schema/delete

delete an schema

['delete']

delete method

curl -X 'DELETE' -d '{"schema_id": "37955251-ee53-453e-b93d-10a00b3c8f2c"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/schema/delete

successful response, 204

error response, ['401', '500']

/api/schema/edit

edit an schema

['put']

put method

curl -X 'PUT' -d '{"schema_id": "ea3e25e6-04ac-4f4c-8fa7-55fd93741059", "name": "sample_name", "description": "this is a sample description", "status": "private"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/schema/edit

successful response, 204

error response, ['401', '500']

/api/schemas

get all existing schemas

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/schemas

successful response, 200

error response, ['401', '500']

/api/schemas/delete/all

delete all schemas

['delete']

delete method

curl -X 'DELETE' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/schemas/delete/all

successful response, 200

error response, ['401', '500']

Stars

/api/star/create

create a star

['post']

post method

curl -X 'POST' -d '{"source_id": "1527cad6-2f98-419e-95bb-19d6e6ceacf4", "source_type": "string", "organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/star/create

successful response, 201

error response, ['401', '500']

/api/star/delete

delete a star

['delete']

delete method

curl -X 'DELETE' -d '{"source_id": "1c92b2ed-e360-4f45-bb6c-dd7eff50b0d2", "source_type": "string"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/star/delete

successful response, 204

error response, ['401', '500']

/api/star/read

read a star

['post']

post method

curl -X 'POST' -d '{"source_id": "4df96ba4-1443-4668-8f83-3800bf335273", "source_type": "string"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/star/read

successful response, 200

error response, ['404', '500']

/api/starred

starred an api

['post']

post method

curl -X 'POST' -d '{"source_type": "string", "organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/starred

successful response, 200

error response, ['401', '500']

Surveys

/api/survey/create

create a survey

['post']

post method

curl -X 'POST' -d '{"organization_id": "", "name": "test survey", "description": "test survey description", "status": "private", "fragments": "{\"audio-c2f83ecd-0e5f-4eb3-81d4-7b36ccc3206d\":\"test\"}", "settings": "{\"undefined\":{\"title\":\"test\",\"clonesurvey\":\"\"},\"audio-c2f83ecd-0e5f-4eb3-81d4-7b36ccc3206d\":{\"allow_multiple_recordings\":\"false\",\"auto_end_recording\":\"true\",\"auto_start\":\"true\",\"count_down\":\"true\",\"large_text\":\"false\",\"operation_featurize_audio\":\"false\",\"operation_transcribe_audio\":\"false\",\"playback_tts\":\"false\",\"playback_tts_allow_multiple\":\"false\",\"playback_tts_autoplay\":\"false\",\"recording_duration\":\"30\"}}"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/survey/create

successful response, 201

error response, ['401', '500']

/api/survey/delete

delete a survey

['delete']

delete method

curl -X 'DELETE' -d '{"survey_id": "59ac4ab7-249f-4e88-a019-f2f2c4e1c757"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/survey/delete

successful response, 204

error response, ['401', '500']

/api/survey/edit

edit a survey

['put']

put method

curl -X 'PUT' -d '{"survey_id": "ce52a4d5-a21d-45cd-b49b-2d1d4449da17", "name": "sample_name", "description": "this is a sample description", "status": "private", "publish_template": false, "auto_retake": false, "restrict_ip_addresses": false, "restrict_languages": false, "restrict_browsers": false, "restrict_devices": false, "restrict_locations": false, "restrict_to_logged_in_users": false, "required_ip_addresses": "{}", "required_languages": "{}", "required_devices": "{}", "required_browsers": "{}", "required_locations": "{}", "required_users": "{}"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/survey/edit

successful response, 204

error response, ['401', '500']

Tokens

/api/token/create

create a token

['post']

post method

curl -X 'POST' -d '{"organization_id": "", "scopes": ["user:read", "apitoken:refresh"], "valid_length_hours": 24}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/token/create

successful response, 201

error response, ['400', '500']

/api/token/delete

delete a token

['delete']

delete method

curl -X 'DELETE' -d '{}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/token/delete

successful response, 204

error response, ['401', '500']

/api/token/refresh

refresh a token

['post']

post method

curl -X 'POST' -d '{"refresh_token": "string"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/token/refresh

successful response, 200

error response, ['400', '500']

/api/token/scopes

get all existing scopes

['get']

get method

curl -X 'GET' -d '{}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/token/scopes

successful response, 200

error response, ['422', '500']

Transactions

/api/transaction/create

create a transaction

['post']

post method

curl -X 'POST' -d '{"dataset_id": "049380a8-96fc-4882-b544-ea4a2c8163de", "price": 29.99, "method": "one-time", "country": "USA", "organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/transaction/create

successful response, 201

error response, ['400', '500']

/api/transactions

get all existing transactions

['post']

post method

curl -X 'POST' -d '{"organization_id": ""}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/transactions

successful response, 200

error response, ['401', '500']

Users

/api/user/edit

edit a user

['put']

put method

curl -X 'PUT' -d '{"first_name": "", "last_name": "", "bio": "", "alias": "", "github_url": "", "status": "private"}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/user/edit

successful response, 204

error response, ['401', '500']

/api/user/read

read a user

['post']

post method

curl -X 'POST' -d '{}' -H 'Content-Type: application/json' -H 'Authorization: Bearer {{session['user_access_token']}}' {{session['base_url']}}//api/user/read

successful response, 200

error response, ['401', '500']

response colors

API Version

Databoard API docs

Articles

▦ Datasets

Flags

Follows

Messages

Notifications

Organizations

Others

Requests

Schemas

Stars

Surveys

Tags

Tokens

Transactions

Users

response colors