REST API
Getting started with the REST API
Getting started with the REST API
Welcome to the Fluid REST API Reference. Representational State Transfer (REST) APIs are service endpoints that support sets of HTTP operations (metho...
REST API Best practices
You should subscribe to webhook events instead of polling the API for data. This will help your integration stay within the API rate limit. For more i...
Action
REST API endpoint for Actions
The Actions API is used for listing, creating, deleting and updating Actions. Actions can be created as User Actions, Actions that are associated to a...
Get Action
Returns a single Action, for the specified id or GUID passed at part of the query. The REST API account user needs to have the correct viewer permissi...
Create Action
Creates a single Action. Can be a user action, or an action linked to a board or other Fluid entity. If creating an Action for a board or other Fluid...
Create Action examples
The below examples illustrate a number of use cases to create a single Actions. UPDATE REST API Calls REST API update calls to an Action must POST al...
Create Action bulk
Creates a bulk set of Actions. The Payload is a collection of Action Objects to be created. The maximum number of Actions that can be created in a sin...
Create Action bulk examples
The below examples illustrate a number of use cases to create a bulk set of Actions. Whilst you become familiar with the API, it is advisable to use a...
List of Actions
Returns a list of Actions as defined by the list of Action ids passed as part of the request query parameters. The REST API account user needs to have...
List all Actions
Returns ALL Actions in the system that the REST API Account has viewer permissions. The REST API account user needs to have the correct viewer permiss...
Update Action
Updates the properties and fields an existing Action. REST API update calls to an Action must POST all fields in the body of the payload. Update call...
Delete Action
Deletes an existing single Action. Deletes in Fluid are non permanent, Actions that are deleted are internally marked as archived and are typically n...
Update Action bulk
Updates a set of Actions. The PUT payload is the collection of Action objects to be updated. The id or guid property of each object in the collection ...
Delete Action bulk
Deletes a set of Actions. The DELETE payload is the collection of Action id/guid string values to be deleted. The id or guid property of each object i...
Update Actions bulk examples
The below examples illustrate a number of use cases to update a set of Actions. REST API update calls to an Action must POST all fields in the body o...
Delete Actions bulk examples
The below examples illustrate a number of use cases to delete a set of Actions. Deletes in Fluid are non permanent, Actions that are deleted are inte...
Update Action examples
The below examples illustrate a number of use cases to update a single Action. REST API update calls to an Action must POST all fields in the body of...
Delete Action example
The below examples illustrate a number of use cases to delete a single Action. Deletes in Fluid are non permanent, Actions that are deleted are inter...
Find Action
Find an Action(s), based on the query string keyword match value passed. The query string value is matched using a contains clause against the followi...
Boards
List All Boards
Returns all Boards the token user is a member or owner of. GET https://organisation.fluid.work/rest/api/board curl --user username:pattoken --locatio...
Find Board
Find a Board(s), based on the query string keyword match value passed. The REST API account needs to have the correct viewer permission for the board ...
Get Board
Returns a single Board, for the specified id or GUID passed at part of the query. The REST API user needs to have the correct permissions. GET https:/...
Rest API endpoint for Boards
The Boards API is used for listing, creating, deleting and updating Boards. UPDATE REST API Calls REST API update calls to an Action must POST all fie...
List of Boards
Returns a list of Boards as defined by the list of Board ids passed as part of the request query parameters. The REST API account user needs to have...
Catalog
Catalog Types