Returns all Boards the token user is a member or owner of.
TABLE OF CONTENTS
Request
HTTP
GET https://organisation.fluid.work/rest/api/board
cURL
curl --user username:pattoken --location 'http://organisation.fluid.work/rest/api/board'
with optional parameters
HTTP
GET https://organisation.fluid.work/rest/api/board?fields={fields}&expand={expand}&version=3.0cURL
curl --user username:pattoken --location 'http://organisation.fluid.work/rest/api/board?fields=all&expand=all&version=3.0'
URL Parameters
| Name | In | Required | Type | Description |
| fields | query | false | string | Comma-separated list of requested fields to be returned as properties of the Board response |
| expand | query | false | string | Expand parameter for Action attributes. Possible options are{"none" "all" "method" "related" "chat" "customAll" "customReportable" "customReadOnly" "subtask" "attachment" "state"} |
| version | query | false | string | Version of the API to use. if not set, default latest version will be used. |
Response
| Name | Type | Description |
| 200 OK | Action | Successful operation |
| 400 | string | Bad Request |
| 429 | string | "Too many Requests" see response headers RateLimit-Limit (current rate limit capacity), RateLimit-Remaining (remaining tokens), RateLimit-Reset (time till next refill) |
Response Headers
| Name | Type | Description |
| RateLimit-Limit | int | Max rate limit of requests allowed |
| RateLimit-Remaining | int | Remaining capacity of requests allowed |
| RateLimit-Reset | string | Next date time for refresh of capacity |
| Item-Count | int | Current number of items returned in this API response |
| Total-Count | int | Total count of items that form this API response, for calls that return more than the max value of 50 items, this count is the total number of items that are apart of this response |
GET Sample Request
cUrl
curl --user username:pattoken --location 'http://organisation.fluid.work/rest/api/board'
Sample Response
Status code: 200
JSON
[
{
"fields": {
"active": true,
"boardCategory": 0,
"boardType": "Kanban",
"cancelledState": "Cancelled",
"cardType": [
{
"cardType": "Bug",
"colourHexValue": "#dc0a34",
"isDefault": false
},
{
"cardType": "Improvement",
"colourHexValue": "#ae3778",
"isDefault": false
},
{
"cardType": "New Feature",
"colourHexValue": "#f66307",
"isDefault": false
},
{
"cardType": "Production Issue",
"colourHexValue": "#121212",
"isDefault": false
},
{
"cardType": "Task",
"colourHexValue": "#2d60a5",
"isDefault": true
},
{
"cardType": "User Story",
"colourHexValue": "#55917f",
"isDefault": false
}
],
"columns": [
{
"id": "485e7b62-5142-4823-873b-11380128cd59",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "08cfaeca-6ab8-42a4-af45-4efc674ed47c",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "ecb7e97a-20dc-486e-bf6b-a716305103cd",
"title": "Completed",
"state": "Completed",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
}
],
"completedState": "Completed",
"created": "2023-09-28T00:00:00.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"description": "Board Description",
"epicFieldName": "Theme",
"instructions": null,
"isPrivate": false,
"membersOnly": false,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2023-09-28T00:00:00.0000000",
"name": "Agile T1",
"notStartedState": "Not Started",
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
]
},
"id": 638,
"guid": "89f97f10-6bbd-4f75-8cf6-ad0fb9d6f3a0",
"url": "https://organisation.fluid.work/rest/api/board/638"
},
{
"fields": {
"active": true,
"boardCategory": 0,
"boardType": "Kanban",
"cancelledState": "Cancelled",
"cardType": [
{
"cardType": "Bug",
"colourHexValue": "#dc0a34",
"isDefault": false
},
{
"cardType": "Improvement",
"colourHexValue": "#ae3778",
"isDefault": false
},
{
"cardType": "New Feature",
"colourHexValue": "#f66307",
"isDefault": false
},
{
"cardType": "Production Issue",
"colourHexValue": "#121212",
"isDefault": false
},
{
"cardType": "Task",
"colourHexValue": "#2d60a5",
"isDefault": true
},
{
"cardType": "User Story",
"colourHexValue": "#55917f",
"isDefault": false
}
],
"columns": [
{
"id": "64912ac9-3585-47c0-bd98-9562db89883b",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "b44f06fd-3b66-4e99-8040-18137cb844ef",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "733bebc2-ccab-40d2-8e25-4621c9f3b3d1",
"title": "Completed",
"state": "Completed",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
}
],
"completedState": "Completed",
"created": "2023-09-28T00:00:00.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"description": Board Description,
"epicFieldName": "Theme",
"instructions": null,
"isPrivate": false,
"membersOnly": false,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2023-09-28T00:00:00.0000000",
"name": "Board Name",
"notStartedState": "Not Started",
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
]
},
"id": 640,
"guid": "ff4164e2-623f-487a-adfd-d38ae24b784e",
"url": "https://organisation.fluid.work/rest/api/board/640"
}
]Get Sample Request with Field and Expand option
cUrl
curl --user username:pattoken --location 'http://organisation.fluid.work/rest/api/board?fields=all&expand=all'
Sample Response
Status code: 200
JSON
[
{
"fields": {
"active": true,
"boardCategory": 0,
"boardType": "Kanban",
"cancelledState": "Cancelled",
"cardType": [
{
"cardType": "Bug",
"colourHexValue": "#dc0a34",
"isDefault": false
},
{
"cardType": "Improvement",
"colourHexValue": "#ae3778",
"isDefault": false
},
{
"cardType": "New Feature",
"colourHexValue": "#f66307",
"isDefault": false
},
{
"cardType": "Production Issue",
"colourHexValue": "#121212",
"isDefault": false
},
{
"cardType": "Task",
"colourHexValue": "#2d60a5",
"isDefault": true
},
{
"cardType": "User Story",
"colourHexValue": "#55917f",
"isDefault": false
}
],
"columns": [
{
"id": "485e7b62-5142-4823-873b-11380128cd59",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "08cfaeca-6ab8-42a4-af45-4efc674ed47c",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "ecb7e97a-20dc-486e-bf6b-a716305103cd",
"title": "Completed",
"state": "Completed",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
}
],
"completedState": "Completed",
"created": "2023-10-13T18:54:00.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"description": "Board Description",
"epicFieldName": "Theme",
"instructions": null,
"isPrivate": false,
"mailToAddress": "638@organisation.app.fluid.work",
"membersOnly": false,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2023-10-13T18:54:00.0000000",
"name": "Agile T1",
"notStartedState": "Not Started",
"openSprints": 0,
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"requestState": null,
"shortCode": null,
"tasksCount": 0
},
"id": 638,
"methods": [
{
"type": "Update",
"httpMethod": "PUT",
"url": "https://organisation.fluid.work/rest/api/board"
},
{
"type": "Delete",
"httpMethod": "DELETE",
"url": "https://organisation.fluid.work/rest/api/board"
}
],
"chats": [
{
"id": 0,
"content": "Welcome to your new board",
"topicId": 0,
"display": "<span> Welcome to your new board</span>",
"initiator": {
"id": 0,
"guid": "00000000-0000-0000-0000-000000000000",
"name": "Dot",
"userName": null,
"email": "609dd11b-b587-4265-bf50-cee92a86fd42"
},
"timestamp": 0.0
}
],
"guid": "89f97f10-6bbd-4f75-8cf6-ad0fb9d6f3a0",
"url": "https://organisation.fluid.work/rest/api/board/0"
},
{
"fields": {
"active": true,
"boardCategory": 0,
"boardType": "Kanban",
"cancelledState": "Cancelled",
"cardType": [
{
"cardType": "Bug",
"colourHexValue": "#dc0a34",
"isDefault": false
},
{
"cardType": "Improvement",
"colourHexValue": "#ae3778",
"isDefault": false
},
{
"cardType": "New Feature",
"colourHexValue": "#f66307",
"isDefault": false
},
{
"cardType": "Production Issue",
"colourHexValue": "#121212",
"isDefault": false
},
{
"cardType": "Task",
"colourHexValue": "#2d60a5",
"isDefault": true
},
{
"cardType": "User Story",
"colourHexValue": "#55917f",
"isDefault": false
}
],
"columns": [
{
"id": "64912ac9-3585-47c0-bd98-9562db89883b",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "b44f06fd-3b66-4e99-8040-18137cb844ef",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "733bebc2-ccab-40d2-8e25-4621c9f3b3d1",
"title": "Completed",
"state": "Completed",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
}
],
"completedState": "Completed",
"created": "2023-10-13T18:54:00.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"description": "Board Description",
"epicFieldName": "Theme",
"instructions": null,
"isPrivate": false,
"mailToAddress": "640@organisation.app.fluid.work",
"membersOnly": false,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"modifiedDate": "2023-10-13T18:54:00.0000000",
"name": "Agile T2",
"notStartedState": "Not Started",
"openSprints": 0,
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"requestState": null,
"shortCode": null,
"tasksCount": 0
},
"id": 640,
"methods": [
{
"type": "Update",
"httpMethod": "PUT",
"url": "https://organisation.fluid.work/rest/api/board"
},
{
"type": "Delete",
"httpMethod": "DELETE",
"url": "https://organisation.fluid.work/rest/api/board"
}
],
"chats": [
{
"id": 0,
"content": "Welcome to your new board",
"topicId": 0,
"display": "<span> Welcome to your new board</span>",
"initiator": {
"id": 0,
"guid": "00000000-0000-0000-0000-000000000000",
"name": "Dot",
"userName": null,
"email": "609dd11b-b587-4265-bf50-cee92a86fd42"
},
"timestamp": 0.0
}
],
"guid": "ff4164e2-623f-487a-adfd-d38ae24b784e",
"url": "https://organisation.fluid.work/rest/api/board/0"
}
]Definitions
| Name | Description |
| id | The Id integer, uniquely identifies this particular Board, can be interchangeable with guid, see below |
| guid | The guid string, uniquely identifies this particular Board , can be interchangeable with id, see above |
| url | The REST GET Url for this Board |
| fields | Map of field and values for the Board |
| modifiedBy | Describes the user who last modified this Board |
| owners[] | Describes a list of users this Board is owned by |
| methods[] | Describes relevant actions that can be made against this Board , including REST url and payload information |
| chats[] | Describes a list of Chat messages associated with this Board |
ModifiedBy
| Name | Description |
| id | The Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below |
| guid | The guid string, uniquely identifies this particular User, can be interchangeable with id, see above |
| name | The long name of this User |
| username | The username associated with this User |
| Unique email associated with this User |
Owners[]
| Name | Description |
| id | The Id integer, uniquely identifies this particular User, can be interchangeable with guid, see below |
| guid | The guid string, uniquely identifies this particular User, can be interchangeable with id, see above |
| name | The long name of this User |
| username | The username associated with this User |
| Unique email associated with this User |
Methods[]
| Name | Description |
| type | The type of action this method performs |
| httpMethod | HTTP Request Method verb |
| url | The REST URL that can be used with the Http Method verb |
| description | Description of what this method performs |
| payload | Sample payload related to the HTTP Method verb. This payload is typically the minimal payload required to perform the verb method. |
Chats[]
| Name | Description |
| id | Unique id for this message |
| content | Content of this message |
| topicId | Topic id this message is apart of |
| display | HTML version of the message content |
| initiator | Describes the user that created this message |
| timestamp | Date/Time when this message was posted |
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article