Quick Start

It provides guidance and examples to assist you in integrating our API seamlessly into your projects.

Authentication

To ensure secure access to our API, all requests must be authenticated using API keys. Any request made without including an API key will result in an error response.

Please make sure to include your unique API key in the request headers or as a query parameter for every API call. This authentication mechanism helps protect your data and ensures that only authorized requests are processed.

Keep your API key confidential and do not share it with unauthorized individuals. If you suspect any misuse or need assistance regarding API key management, please contact our support team.

You can find your api_keys key in your account page, you just easily copy and paste it. It will serve as your authentication to access data from your projects. Make sure not to share it with anyone.

Endpoints

Tip: We highly recommend using POSTMAN for testing and interacting with our API during the development of your projects. POSTMAN provides a user-friendly interface that allows you to send API requests, inspect responses, and manage your API testing workflow efficiently. It's a valuable tool to ensure smooth integration and debugging of your API interactions.

Download our POSTMAN API collection.

Lets start your first request

Create Row

POST https://api.fruitask.com/v3/tables/{token}/rows/?api_key=YOUR_API

You can create a new row to your project with values or empty row. To create empty row just leave the body request blank.

Note: Use raw body request type instead of form-data or x-www-urlencoded-form.

Path Parameters

Name
Type
Description

api_key*

String

YOUR_API

Headers

Name
Type
Description

Content-Type

String

application/json

Request Body

Name
Type
Description

{"Name":"John Doe","Info":"Hello Fruitask","Status":"Completed"}

JSON

Value

See sample create row code snippets.

curl -X POST 'https://api.fruitask.com/v3/tables/{token}/rows/?api_key=YOUR_API' \
     -H 'Content-Type: application/json' \
     -d '{
        "name": "John Doe",
        "email": "john@example.com",
        "age": 30
     }'

Update Row

PUT https://api.fruitask.com/v3/tables/{token}/rows/{id}/?api_key=YOUR_API

You can update a row values to your project using row id.

Path Parameters

Name
Type
Description

id*

Integer

Query Parameters

Name
Type
Description

api_key*

String

YOUR_API

Headers

Name
Type
Description

Content-type*

String

application/json

Request Body

Name
Type
Description

{"Name":"John Doe","Info":"Hello Fruitask","Status":"On-going"}*

JSON

Updated value

curl -X PUT 'https://api.fruitask.com/v3/tables/{token}/rows/{id}/?api_key=YOUR_API' \
     -H 'Content-Type: application/json' \
     -d '{
        "name": "John Doe",
        "email": "john@example.com",
        "age": 30
     }'

Update Cell

PUT https://api.fruitask.com/v3/tables/{token}/update/{id}/?api_key=YOUR_API

Path Parameters

Name
Type
Description

token*

String

Project token

id*

integer

Your row id position

Query Parameters

Name
Type
Description

api_key*

String

YOUR_API

Request Body

Name
Type
Description

{"column_name":"Info", "value": "Hey there!" }*

JSON

Your new value and the column

{
    "success": true,
    "result": "Cell updated successfully.",
    "row": 7
}

See sample update row code snippets.

Get all rows

GET https://api.fruitask.com/v3/tables/{token}/rows/?api_key=YOUR_API

You can pull all rows from your project.

Originally the value is encrypted, but once it fetch with your API keys, it should auto decrypt the values. See sample of encrypted values. Don't worry if live API request it is decrypted.

Query Parameters

Name
Type
Description

api_key*

String

{
    "success": true,
    "result": [
        {
            "Name": "VzhWY25kcFJNSW1DYnJVPQ",
            "Info": "Uk45TWxkNEZEWkNmZlBoNW9rc0cvbWVpQncyTXQxMWhpZ0Y1TTNoOHVMcXM3T1QvS2VRPQ",
            "Status": "Vk1WRGlOc1VEWnlW",
            "Sample": "Zjk1YWlNUkxWdGFYYWExOXQxZ2U4RDJvQmdlRHUwOW1pZ2RqZlhKcStieTg3dTdwY3ZIQ2s3UEpoZWM9"
        },
        {
            "Name": "Uk10RGlOc1VXYjJRYjdrPQ",
            "Info": "UXRwQ2w5WVZXWmlmZi9oeHAxQVp1MmVqREVyY3MwWnZqbE56UFhwNy9hYTk",
            "Status": "Ujg5QW5ONGZIZz09",
            "Sample": "Zjk1YWlNUkxWdGFYYWExOXQxZ2U4RDJvQmdlRHUwOW1pZ2RqZlhKcStieTg3dTdwY3VEQ3llM1hqQT09"
        },
        {
            "Name": "V3RNTHlvY2xISlNCZDdsZ3BnPT0",
            "Info": "",
            "Status": "",
            "Sample": ""
        },
        {
            "Name": "",
            "Info": "",
            "Status": "",
            "Sample": ""
        }
    ]
}
curl -X GET 'https://api.fruitask.com/v3/tables/{token}/rows/?api_key=YOUR_API'

Get Parse

GET https://api.fruitask.com/v3/tables/{token}/parse/?api_key=YOUR_API

You can pull multiple workplace data in a single API call using this endpoint. Make sure to use

Link workplace //column type 

It will create extra key value parsed_data

You can also use extension with Workplace Dropdown, install the extension to any workplace, you will have the configuration to single dropdown settings. You can sync or connect workplace, and make your dropdown data. This still experimental and only use the first column data as your dropdown.

It will create extra key value sync_drop{row_position}

Output Usage

curl -X GET 'https://api.fruitask.com/v3/tables/{token}/parse/?api_key=YOUR_API'

{
    "success": true,
    "result": [
        {
            "Name": "Properties",
            "Info": "",
            "W458": "Star Fruit",
            "Sample": "",
            "parsed_data": "No data found" // if you don't use token
        },
        {
            "Name": "Users",
            "Info": "",
            "W458": "ISgam4MEqsJFJvw", //workplace token
            "Sample": "",
            "sync_drop1": [ //pulled data using Workplace Dropdown extension
                {
                    "Name": "John Doe",
                    "Gender": "Male",
                    "Age": "63"
                },
                {
                    "Name": "Lexi Lore",
                    "Gender": "Female",
                    "Age": "30"
                }
            "parsed_data": [ //pulled data using Link workplace column type
                {
                    "Name": "John Doe",
                    "Gender": "Male",
                    "Age": "63"
                },
                {
                    "Name": "Lexi Lore",
                    "Gender": "Female",
                    "Age": "30"
                }
                //.. more
            ]
        },
        {
            "Name": "",
            "Info": "",
            "W458": "",
            "Sample": ""
        }
        //... do it more
    ]
}

Get Row

GET https://api.fruitask.com/v3/tables/{token}/rows/{id}/?api_key=YOUR_API

You can pull a specific row data with row id.

Path Parameters

Name
Type
Description

id*

integer

Row position from your project

Query Parameters

Name
Type
Description

api_key*

String

YOUR_API

{
    "success": true,
    "result": {
        "Name": "Uk10RGlOc1VXYjJRYjdrPQ",
        "Info": "UXRwQ2w5WVZXWmlmZi9oeHAxQVp1MmVqREVyY3MwWnZqbE56UFhwNy9hYTk",
        "Status": "Ujg5QW5ONGZIZz09",
        "Sample": "Zjk1YWlNUkxWdGFYYWExOXQxZ2U4RDJvQmdlRHUwOW1pZ2RqZlhKcStieTg3dTdwY3VEQ3llM1hqQT09"
    }
}
curl -X GET 'https://api.fruitask.com/v3/tables/{token}/rows/{id}/?api_key=YOUR_API'

Get Quota

GET https://api.fruitask.com/v3/quota/{token}/?api_key=YOUR_API

Get workplace/table limit. Remember a single project is limited to 60KB overall data counts per letters.

Path Parameters

Name
Type
Description

token*

String

Project token

Query Parameters

Name
Type
Description

api_key*

String

Account API key

{
    "success": true,
    "result": {
        "used_limit": 21,
        "max_limit": 60,
        "by_percentage": 32
    }
}
curl -X GET 'https://api.fruitask.com/v3/quota/{token}/?api_key=YOUR_API'

Get Collaborators

GET https://api.fruitask.com/v3/users/{token}/?api_key=YOUR_API

Path Parameters

Name
Type
Description

token*

String

YOUR PROJECT TOKEN

Query Parameters

Name
Type
Description

api_key*

String

YOUR API KEY

Delete Row

DELETE https://api.fruitask.com/v3/tables/{token}/rows/{id}/?api_key=YOUR_API

You can delete a specific row using row id.

Path Parameters

Name
Type
Description

id*

Integer

Row position

Query Parameters

Name
Type
Description

api_key*

String

YOUR_API

{
    "success": true,
    "result": "Row deleted successfully.",
    "row": 17
}
curl -X DELETE 'https://api.fruitask.com/v3/tables/{token}/rows/{id}/?api_key=YOUR_API'

Last updated