Fusioo API methods

Ping

Used to verify the authentication credentials users provide when they first use your application. If the response returns a 200 status code, the credentials are valid.

Resource URL

GET https://api.fusioo.com/v1/ping

Resource Information

Response format JSON
Requires authentication? Yes
Rate limited? No

Example Request

GET https://api.fusioo.com/v1/ping

cURL request


curl -X GET 
     -H "Authorization: Bearer {access token}" 
     -H "Cache-Control: no-cache" 
     "https://api.fusioo.com/v1/ping"

Example Result


{
  "code": 10000,
  "message": "Success",
  "data": {}
}
            

Create Record

Creates a new record in a specific Fusioo App. To successfully create the record, the authenticated user must have create access for that App.

Resource URL

POST https://api.fusioo.com/v1/records/apps/app_id
app_id The id of the Fusioo App in which the new record will be created. The App id can be found by going to the Developer Information section in Fusioo.

Resource Information

Response format JSON
Requires authentication? Yes
Rate limited? Yes

Parameters

  • The request body should contain the record to be created in JSON format. For more information on the accepted format for different Field Types, check out the Field Types section.

To successfully create a record, all Fields that are marked as required should be included in the request body. Field options should also be respected or else validation errors will be displayed.

Example Request

POST https://api.fusioo.com/v1/records/apps/ia4f42

Request body


{  
   "title":"Start using the API",
   "notes":"Go through the Fusioo API documentation to get familiar with what can be achieved.",
   "priority":[  
      "High"
   ],
   "due_date":"2016-09-30",
   "responsible":[  
      "Lauren Moss"
   ],
   "status":[  
      "In progress"
   ]
}

cURL request


curl -X POST 
	 -H "Authorization: Bearer {access token}" 
	 -H "Content-Type: application/json" 
	 -H "Cache-Control: no-cache" 
	 -d '{
		  "title": "Start using the API",
		  "notes": "Go through the Fusioo API documentation to get familiar with what can be achieved.",
		  "priority": [
		     "High"
		  ],
		  "due_date": "2016-09-30",
		  "responsible": [
		    "Lauren Moss"
		  ],
		  "status": [
		    "In progress"
		  ]
		}' 
	 "https://api.fusioo.com/v1/records/apps/ia4f42"

Example Result


{
  "code": 10000,
  "message": "Success",
  "data": {
    "id": "i59adb",
    "title": "Start using the API"
  }
}
            

Possible Issues

30000App not found
30001App access denied
30002Cannot create App records
30050Record validation errors

Get Record

Used to retrieve the details of a specific record in Fusioo. The Fields included in the response object depend on the access settings of the authenticated user.

Resource URL

GET https://api.fusioo.com/v1/records/record_id
record_id The id of the record which will be retrieved. The record id can be found by going to the Developer Information section in Fusioo.

Resource Information

Response format JSON
Requires authentication? Yes
Rate limited? Yes

Example Request

GET https://api.fusioo.com/v1/records/i59adb

cURL request


curl -X GET
	 -H "Authorization: Bearer {access token}"
	 -H "Content-Type: application/json"
	 -H "Cache-Control: no-cache"
	 "https://api.fusioo.com/v1/records/i59adb"

Example Result


{  
   "code":10000,
   "message":"Success",
   "data":{  
      "id":"i59adb",
      "title":"Start using the API",
      "notes":"Go through the Fusioo API documentation to get familiar with what can be achieved.",
      "priority":[  
         "High"
      ],
      "due_date":"2016-09-30",
      "responsible":[  
         "Lauren Moss"
      ],
      "status":[  
         "In progress"
      ],
      "created":"2016-09-23T20:07:12",
      "last_modified":"2016-09-23T20:07:12",
      "created_by":[  
         "John Doe"
      ],
      "last_modified_by":[  
         "John Doe"
      ]
   }
}
            

Possible Issues

30001App access denied
30051Record not found
30052Record access denied

Get Records

Used to retrieve all records in a specific App. The Fields and records included in the response object depend on the access settings of the authenticated user.

Resource URL

GET https://api.fusioo.com/v1/records/apps/app_id
app_id The id of the Fusioo App from which the records will be retrieved. The App id can be found by going to the Developer Information section in Fusioo.

Resource Information

Response format JSON
Requires authentication? Yes
Rate limited? Yes
Parameter Description
sort_by optional - string The Field which is used to sort the retrieved records. The value should contain the Field Id. When left empty, the Key Field is used to sort the records.
order optional - string The sort direction. Accepts asc or desc. Default value: asc.
offset optional - integer Which record in the list to start from. Value should be greater than 0. Default value: 0.
limit optional - integer How many records should be retrieved. Accepts any value between 0 and 200. Default value: 200.

Example Request

GET https://api.fusioo.com/v1/records/apps/id5dcd

cURL request


curl -X GET 
	 -H "Content-Type: application/json" 
	 -H "Authorization: Bearer {access token}" 
	 -H "Cache-Control: no-cache" 
	 "https://api.fusioo.com/v1/records/apps/id5dcd?sort_by=title&order=asc&offset=30&limit=100"

Example Result


{  
   "code":10000,
   "message":"Success",
   "data":[  
      {  
         "id":"i5d3b0",
         "title":"Another Task",
         "notes":"Notes on this important Task.",
         "priority":[  
            "Critical"
         ],
         "due_date":"2016-09-24",
         "responsible":[  
            "Charlotte Smith"
         ],
         "status":[  
            "In progress"
         ],
         "created":"2016-09-19T20:09:34",
         "last_modified":"2016-09-22T22:02:17",
         "created_by":[  
            "John Doe"
         ],
         "last_modified_by":[  
            "John Doe"
         ]
      },
      {  
         "id":"i59adb",
         "title":"Start using the API",
         "notes":"Go through the Fusioo API documentation to get familiar with what can be achieved.",
         "priority":[  
            "High"
         ],
         "due_date":"2016-09-30",
         "responsible":[  
            "Lauren Moss"
         ],
         "status":[  
            "In progress"
         ],
         "created":"2016-09-23T20:07:12",
         "last_modified":"2016-09-23T20:07:12",
         "created_by":[  
            "John Doe"
         ],
         "last_modified_by":[  
            "John Doe"
         ]
      }
   ]
}
            

Possible Issues

30000App not found
30001App access denied
30100Field used to sort does not exist
30101Field used is not sortable
30102Cannot access the 'Sort By' Field
30103Sort direction is invalid
30104Records offset is invalid
30105Records limit is invalid

Update Record

Updates an existing Fusioo record. To successfully update the record, the authenticated user must have update access to the App and the newly updated Fields.

Resource URL

PATCH https://api.fusioo.com/v1/records/record_id
record_id The id of the record which will be updated. The record id can be found by going to the Developer Information section in Fusioo.

Resource Information

Response format JSON
Requires authentication? Yes
Rate limited? Yes

Parameters

  • The request body should contain all the updated record Fields. For more information on the accepted format for different Field Types, check out the Field Types section.

Only the Fields included in the request body will be updated. The value of the Fields not included in the request will not be updated.

Example Request

PATCH https://api.fusioo.com/v1/records/i59adb

Request body


{  
   "priority":[  
      "Normal"
   ],
   "status":[  
      "Done"
   ]
}

cURL request


curl -X PATCH
	 -H "Authorization: Bearer {access token}"
	 -H "Content-Type: application/json"
	 -H "Cache-Control: no-cache"
	 -d '{
              "priority": [
                "Normal"
              ],
              "status": [
                "Done"
              ]
             }'
	 "https://api.fusioo.com/v1/records/i59adb"

Example Result


{
  "code": 10000,
  "message": "Success",
  "data": {}
}
            

Possible Issues

30001App access denied
30003Cannot update App records
30050Record validation errors
30051Record not found
30052Record access denied

Delete Record

Deletes an existing Fusioo record. To successfully delete the record, the authenticated user must have delete access for the App in which the record is found.

Resource URL

DELETE https://api.fusioo.com/v1/records/record_id
record_id The id of the record which will be deleted. The record id can be found by going to the Developer Information section in Fusioo.

Resource Information

Response format JSON
Requires authentication? Yes
Rate limited? Yes

Example Request

DELETE https://api.fusioo.com/v1/records/i59adb

cURL request


curl -X DELETE
	 -H "Authorization: Bearer {access token}"
	 -H "Content-Type: application/json"
	 -H "Cache-Control: no-cache"
	 "https://api.fusioo.com/v1/records/i59adb"

Example Result


{
  "code": 10000,
  "message": "Success",
  "data": {}
}
            

Possible Issues

30001App access denied
30004Cannot delete App records
30051Record not found
30052Record access denied

Get Apps

Retrieves the information of all Apps in the authenticated user's workspace. Apps are retrieved depending on the authenticated user’s Role permissions.

Resource URL

GET https://api.fusioo.com/v1/apps/

Resource Information

Response format JSON
Requires authentication? Yes
Rate limited? Yes

Example Request

GET https://api.fusioo.com/v1/apps

cURL request


curl -X GET 
	 -H "Content-Type: application/json" 
	 -H "Authorization: Bearer {access token}" 
	 -H "Cache-Control: no-cache" 
	 "https://api.fusioo.com/v1/apps/"

Example Result


{  
   "code":10000,
   "message":"Success",
   "data":[  
      {  
         "name":"Clients",
         "id":"i502fb",
         "single_record_name":"Client",
         "fields":[  
            {  
               "id":"name",
               "name":"Name",
               "type":"text",
               "is_required":true,
               "can_update":true,
               "options":{  

               }
            },
            {  
               "id":"website",
               "name":"Website",
               "type":"web_url",
               "is_required":false,
               "can_update":true,
               "options":{  

               }
            },
            {  
               "id":"contact_info",
               "name":"Contact info",
               "type":"text",
               "is_required":false,
               "can_update":true,
               "options":{  

               }
            }
         ]
      },
      {  
         "name":"Tasks",
         "id":"ia4f42",
         "single_record_name":"Task",
         "fields":[  
            {  
               "id":"title",
               "name":"Title",
               "type":"text",
               "is_required":true,
               "can_update":true,
               "options":{  
                  "help_message":"Insert the Task title"
               }
            },
            {  
               "id":"priority",
               "name":"Priority",
               "type":"list",
               "is_required":false,
               "can_update":true,
               "options":{  
                  "items":[  
                     "Low",
                     "Normal",
                     "High",
                     "Critical"
                  ],
                  "default":"Normal",
                  "allow_multiple":false
               }
            },
            {  
               "id":"due_date",
               "name":"Due date",
               "type":"date",
               "is_required":false,
               "can_update":true,
               "options":{  

               }
            },
            {  
               "id":"responsible",
               "name":"Responsible",
               "type":"user_link",
               "is_required":false,
               "can_update":true,
               "options":{  
                  "items":[  
                     "John Doe",
                     "Sarah May",
                     "Charlotte Smith",
                     "Lauren Moss",
                     "Ellie Brooks"
                  ],
                  "allow_multiple":false,
                  "auto_subscribe":true
               }
            }
         ]
      }
   ]
}
            

Get App

Retrieves the information of a specific App in the authenticated user's workspace.

Resource URL

GET https://api.fusioo.com/v1/apps/app_id
app_id The id of the App which will be retrieved. The App id can be found by going to the Developer Information section in Fusioo.

Resource Information

Response format JSON
Requires authentication? Yes
Rate limited? Yes

Example Request

GET https://api.fusioo.com/v1/apps/ia4f42

cURL request


curl -X GET 
	 -H "Content-Type: application/json" 
	 -H "Authorization: Bearer {access token}" 
	 -H "Cache-Control: no-cache" 
	 "https://api.fusioo.com/v1/apps/ia4f42"

Example Result


{  
   "code":10000,
   "message":"Success",
   "data":{  
      "name":"Tasks",
      "id":"ia4f42",
      "single_record_name":"Task",
      "fields":[  
         {  
            "id":"title",
            "name":"Title",
            "type":"text",
            "is_required":true,
            "can_update":true,
            "options":{  
               "help_message":"Insert the Task title"
            }
         },
         {  
            "id":"priority",
            "name":"Priority",
            "type":"list",
            "is_required":false,
            "can_update":true,
            "options":{  
               "items":[  
                  "Low",
                  "Normal",
                  "High",
                  "Critical"
               ],
               "default":"Normal",
               "allow_multiple":false
            }
         },
         {  
            "id":"due_date",
            "name":"Due date",
            "type":"date",
            "is_required":false,
            "can_update":true,
            "options":{  

            }
         },
         {  
            "id":"responsible",
            "name":"Responsible",
            "type":"user_link",
            "is_required":false,
            "can_update":true,
            "options":{  
               "items":[  
                  "John Doe",
                  "Sarah May",
                  "Charlotte Smith",
                  "Lauren Moss",
                  "Ellie Brooks"
               ],
               "allow_multiple":false,
               "auto_subscribe":true
            }
         }
      ]
   }
}
            

Possible Issues

30000App not found
30001App access denied
What would you improve in this article?