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 the correct viewer permissions on an Board for it to be included in the list of responses.
OpenAPI documentation can be found at https://organisation.fluid.work/docs where organisation is the name of your organisation.
HTTP
GET https://organisation.fluid.work/rest/api/board?id={ids}Curl
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/board?id=630,710'
with optional parameters
HTTP
GET https://organisation.fluid.work/rest/api/board?id={ids}&fields={fields}&expand={expand}&version=3.0Curl
curl --user username:patToken --location 'http://organisation.fluid.work/rest/api/board?id=630,710&fields=all&expand=all' URL Parameters
Name | In | Required | Type | Description |
id | path | true | string | Comma-separated list if Board Ids, Ids can be an integer sting value ### or guid string, both are unique identifiers for this Board and can be used interchangeably. |
fields | query | false | string | Comma-separated list of requested fields |
expand | query | false | string | Expand parameter for Board attributes. Possible options are{"none" "all" "method" "related" "chat"} |
skip | query | false | integer | Number of items to skip in the response results. Used for paging response results. see Getting started with the REST Api |
take | query | false | integer | Number of items to take after skip has been applied in the response results . Used for paging response results . see Getting started with the REST Api |
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 |
404 | string | "Board Not Found for {id}" |
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:pat_token --location 'http://organisation.fluid.work/rest/api/action?id=630,710'Sample Response
Status code: 200
JSON
[
{
"fields": {
"active": true,
"boardCategory": 0,
"boardType": "Kanban",
"cancelledState": "Cancelled",
"cardType": [
{
"cardType": "Bug",
"colourHexValue": "#dc0a34",
"isDefault": false
},
{
"cardType": "Epic",
"colourHexValue": "#3f7cac",
"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": "f02b2f90-7320-4e66-9e3f-4c342c38c901",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "cec38aa4-35c2-4472-8a65-b35d63b8e527",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "7b3d98ba-2491-4853-af32-3f74be0a0efb",
"title": "Completed",
"state": "Completed",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
}
],
"completedState": "Completed",
"created": "0001-01-01T00:00:00.0000000",
"createdBy": null,
"description": null,
"epicFieldName": "Theme",
"isPrivate": false,
"members": [
{
"id": 600,
"guid": "f8526047-c79f-4924-bcd8-c172ef38c5d8",
"name": "Natasha Romanoff",
"userName": "natasha.romanoff",
"email": "natasha.romanoff@fluidbsg.com"
}
],
"membersOnly": false,
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00.0000000",
"name": "Sample",
"notStartedState": "Not Started",
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
{
"id": 598,
"guid": "1020642e-3e48-49aa-a693-dd8be2b7795c",
"name": "Bruce Banner",
"userName": "bruce.banner",
"email": "bruce.banner@fluidbsg.com"
},
{
"id": 595,
"guid": "b0a1e7e6-2389-4cdc-8d7e-5263eb512e0d",
"name": "Adam Jones",
"userName": "adam.jones",
"email": "dump7@fluidbsg.com"
}
],
"subBoards": [
{
"guid": "b6977faf-bcdd-4a41-8ce1-1e0abe68e55f",
"id": 0,
"context": {
"name": "Sample",
"score": 0.0,
"type": "Board",
"externalReference": "",
"email": null,
"shortCode": "D",
"isPrivate": false,
"isConnection": true,
"isCatalog": false,
"catalogType": null,
"avatarUrl": "/Content/images/logos/Board.svg",
"emailOptIn": true,
"guid": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
"id": 630,
"referenceId": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
"active": true
},
"targetGuid": "b6977faf-bcdd-4a41-8ce1-1e0abe68e55f",
"title": "Sample",
"startDate": "2022-12-19T09:54:45.0000000",
"status": "In Progress",
"modified": 0.0,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"created": "2022-12-19T09:54:45.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"comments": 0,
"taskCount": 19,
"boardType": null,
"boardCategory": 0,
"velocity": 0.0,
"isClosed": false
}
],
"taskCount": null,
"viewers": [
{
"id": 582,
"guid": "2b4609b6-299c-41b4-bd5d-1ec991e31247",
"name": "Mike Johnson",
"userName": "mike.johnson",
"email": "dump11@fluidbsg.com"
}
]
},
"id": 630,
"guid": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
"url": "https://organisation.fluid.work/rest/api/board/630"
},
{
"fields": {
"active": false,
"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": "af1a955e-96cd-429e-a092-05f9d32509bb",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "4435c917-de92-4df0-8d71-8381ace82c3a",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "9c285d16-7fc2-41fa-ab76-060d3fd4bcb7",
"title": "Completed",
"state": "Completed",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
}
],
"completedState": "Completed",
"created": "0001-01-01T00:00:00.0000000",
"createdBy": null,
"description": null,
"epicFieldName": "Theme",
"isPrivate": false,
"membersOnly": false,
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00.0000000",
"name": "Sample 2",
"notStartedState": "Not Started",
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"subBoards": [
{
"guid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"id": 0,
"context": {
"name": "Sample 2",
"score": 0.0,
"type": "Board",
"externalReference": "",
"email": null,
"shortCode": "DT",
"isPrivate": false,
"isConnection": true,
"isCatalog": false,
"catalogType": null,
"avatarUrl": "/Content/images/logos/Board.svg",
"emailOptIn": true,
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"id": 710,
"referenceId": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"active": false
},
"targetGuid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"title": "Sample 2",
"startDate": "2024-06-10T16:53:54.0000000",
"status": "Not Started",
"modified": 0.0,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"created": "2024-06-10T16:53:54.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"comments": 0,
"taskCount": 0,
"boardType": null,
"boardCategory": 0,
"velocity": 0.0,
"isClosed": false
}
],
"taskCount": null
},
"id": 710,
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"url": "https://organisation.fluid.work/rest/api/board/710"
}
]Get Sample Request with Expand option
cUrl
curl --user username:pat_token --location 'http://organisation.fluid.work/rest/api/action?id=630,710&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": "Epic",
"colourHexValue": "#3f7cac",
"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": "f02b2f90-7320-4e66-9e3f-4c342c38c901",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "cec38aa4-35c2-4472-8a65-b35d63b8e527",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "7b3d98ba-2491-4853-af32-3f74be0a0efb",
"title": "Completed",
"state": "Completed",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
}
],
"completedState": "Completed",
"created": "0001-01-01T00:00:00.0000000",
"createdBy": null,
"description": null,
"epicFieldName": "Theme",
"isPrivate": false,
"mailToAddress": "630@dev-tmpblank.app.fluid.work",
"members": [
{
"id": 600,
"guid": "f8526047-c79f-4924-bcd8-c172ef38c5d8",
"name": "Natasha Romanoff",
"userName": "natasha.romanoff",
"email": "natasha.romanoff@fluidbsg.com"
}
],
"membersOnly": false,
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00.0000000",
"name": "Sample",
"notStartedState": "Not Started",
"openSprints": 0,
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
{
"id": 598,
"guid": "1020642e-3e48-49aa-a693-dd8be2b7795c",
"name": "Bruce Banner",
"userName": "bruce.banner",
"email": "bruce.banner@fluidbsg.com"
},
{
"id": 595,
"guid": "b0a1e7e6-2389-4cdc-8d7e-5263eb512e0d",
"name": "Adam Jones",
"userName": "adam.jones",
"email": "dump7@fluidbsg.com"
}
],
"subBoards": [
{
"guid": "b6977faf-bcdd-4a41-8ce1-1e0abe68e55f",
"id": 0,
"context": {
"name": "Sample",
"score": 0.0,
"type": "Board",
"externalReference": "",
"email": null,
"shortCode": "D",
"isPrivate": false,
"isConnection": true,
"isCatalog": false,
"catalogType": null,
"avatarUrl": "/Content/images/logos/Board.svg",
"emailOptIn": true,
"guid": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
"id": 630,
"referenceId": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
"active": true
},
"targetGuid": "b6977faf-bcdd-4a41-8ce1-1e0abe68e55f",
"title": "Sample",
"startDate": "2022-12-19T09:54:45.0000000",
"status": "In Progress",
"modified": 0.0,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"created": "2022-12-19T09:54:45.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"comments": 0,
"taskCount": 19,
"boardType": null,
"boardCategory": 0,
"velocity": 0.00,
"isClosed": false
}
],
"taskCount": null,
"viewers": [
{
"id": 582,
"guid": "2b4609b6-299c-41b4-bd5d-1ec991e31247",
"name": "Mike Johnson",
"userName": "mike.johnson",
"email": "dump11@fluidbsg.com"
}
]
},
"id": 630,
"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": "Created and set to Not Started by @DavidBurt",
"topicId": 22751,
"display": "Created and set to Not Started by <span class=\"atwho-inserted\"><span class=\"mention\"><span class=\"mention-thumb\"><img src=\"https://organisation.fluid.work/Principal/Initials/DB\" class=\"mention-avatar\"></span><span class=\"mention-text\">@DavidBurt</span></span></span>",
"initiator": {
"id": 0,
"guid": "00000000-0000-0000-0000-000000000000",
"name": "Dot",
"userName": null,
"email": "609dd11b-b587-4265-bf50-cee92a86fd42"
},
"timestamp": "2024-06-11T14:09:45.0000000"
},
{
"id": 0,
"content": "Successfully Updated Azure DevOps action item- 8153 by @System",
"topicId": 22678,
"display": "Successfully Updated Azure DevOps action item- <a href=\"https://fluidbusinesssolutions.visualstudio.com/9eb08e50-6927-4e91-a10d-1c0ab6d578d6/_workitems/edit/8153\" target=\"_blank\" rel=\"noopener noreferrer\">8153</a> by <span class=\"atwho-inserted\"><span class=\"mention\"><span class=\"mention-thumb\"><img src=\"https://organisation.fluid.work/Content/public/images/brand/icon.svg?v=1\" class=\"mention-avatar\"></span><span class=\"mention-text\">@System</span></span></span>",
"initiator": {
"id": 0,
"guid": "00000000-0000-0000-0000-000000000000",
"name": "Dot",
"userName": null,
"email": "609dd11b-b587-4265-bf50-cee92a86fd42"
},
"timestamp": "2024-06-07T16:13:02.0000000"
}
],
"guid": "a4f06c8d-9e45-4737-a12d-787bf4c12cee",
"url": "https://organisation.fluid.work/rest/api/board/630"
},
{
"fields": {
"active": false,
"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": "af1a955e-96cd-429e-a092-05f9d32509bb",
"title": "Not Started",
"state": "Not Started",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "4435c917-de92-4df0-8d71-8381ace82c3a",
"title": "In Progress",
"state": "In Progress",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
},
{
"id": "9c285d16-7fc2-41fa-ab76-060d3fd4bcb7",
"title": "Completed",
"state": "Completed",
"slaDays": 0,
"complete": false,
"rating": 0.0,
"colOwners": [],
"colTeam": [],
"order": 0,
"actions": [],
"createProject": false,
"defaultProjectStatus": ""
}
],
"completedState": "Completed",
"created": "0001-01-01T00:00:00.0000000",
"createdBy": null,
"description": null,
"epicFieldName": "Theme",
"isPrivate": false,
"mailToAddress": "710@dev-tmpblank.app.fluid.work",
"membersOnly": false,
"modifiedBy": null,
"modifiedDate": "0001-01-01T00:00:00.0000000",
"name": "Sample 2",
"notStartedState": "Not Started",
"openSprints": 0,
"owners": [
{
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
}
],
"subBoards": [
{
"guid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"id": 0,
"context": {
"name": "Sample 2",
"score": 0.0,
"type": "Board",
"externalReference": "",
"email": null,
"shortCode": "DT",
"isPrivate": false,
"isConnection": true,
"isCatalog": false,
"catalogType": null,
"avatarUrl": "/Content/images/logos/Board.svg",
"emailOptIn": true,
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"id": 710,
"referenceId": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"active": false
},
"targetGuid": "3078fa15-fca7-40dd-9e6c-34a0b6e40cf3",
"title": "Sample 2",
"startDate": "2024-06-10T16:53:54.0000000",
"status": "Not Started",
"modified": 0.0,
"modifiedBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"created": "2024-06-10T16:53:54.0000000",
"createdBy": {
"id": 603,
"guid": "f1cb6467-0262-4539-9148-7b869defd817",
"name": "David Burt",
"userName": "david.burt",
"email": "dump18@fluidbsg.com"
},
"comments": 0,
"taskCount": 0,
"boardType": null,
"boardCategory": 0,
"velocity": 0.00,
"isClosed": false
}
],
"taskCount": null
},
"id": 710,
"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": "Status changed from In Progress to Not Started by @DavidBurt",
"topicId": 22733,
"display": "Status changed from In Progress to Not Started by <span class=\"atwho-inserted\"><span class=\"mention\"><span class=\"mention-thumb\"><img src=\"https://organisation.fluid.work/Principal/Initials/DB\" class=\"mention-avatar\"></span><span class=\"mention-text\">@DavidBurt</span></span></span>",
"initiator": {
"id": 0,
"guid": "00000000-0000-0000-0000-000000000000",
"name": "Dot",
"userName": null,
"email": "609dd11b-b587-4265-bf50-cee92a86fd42"
},
"timestamp": "2024-06-10T16:59:20.0000000"
},
{
"id": 0,
"content": "Status changed from Not Started to In Progress by @DavidBurt",
"topicId": 22732,
"display": "Status changed from Not Started to In Progress by <span class=\"atwho-inserted\"><span class=\"mention\"><span class=\"mention-thumb\"><img src=\"https://organisation.fluid.work/Principal/Initials/DB\" class=\"mention-avatar\"></span><span class=\"mention-text\">@DavidBurt</span></span></span>",
"initiator": {
"id": 0,
"guid": "00000000-0000-0000-0000-000000000000",
"name": "Dot",
"userName": null,
"email": "609dd11b-b587-4265-bf50-cee92a86fd42"
},
"timestamp": "2024-06-10T16:59:16.0000000"
}
],
"guid": "abbac935-f5ec-4dbb-b6dc-2e93c0680100",
"url": "https://organisation.fluid.work/rest/api/board/710"
}
]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 |
name | Name of the Board |
description | Description for this Board |
mailToAddress | |
modifiedBy | The user who last modified this Board |
membersOnly | |
isPrivate | Board is private |
members[] | Describes a list of users that are members of this board and can contribute to the board |
owners[] | Describes a list of users this Board is owned by, owners can update Board configuration |
viewers[] | Describes a list of users that have view only access to the Board, these users can not contribute to the board. |
cardType[] | List of supported task/card types that can be created on this Board |
columns[] | List of the column for the Board |
subBoards[] | If this is a Board workspace, list of sub boards associated with this workspace, sub boards share the same configuration for the board workspace, such as columns and cardTypes etc |
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 |
Members[]
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 |
Viewers[]
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 |
CardType[]
Name | Description |
cardType | Name of the task/card type that can be created on this Board |
colourHexValue | Colour associated with this task/card as displayed on the Board and task/card creation dialog |
isDefault | Default task/card selected whn creating, as displayed in the create dialog |
Columns[]
Name | Description |
id | The guid string, uniquely identifies this particular column |
title | The title of this column |
state | state/status of this column, any card in this column will have this state/status applied |
slaDays | |
complete | Is this column a completed state/status column |
rating | integer rating value to apply on this column |
order | left to right position ordering of this column |
SubBoards[]
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 |
title | |
status | The username associated with this User |
modifiedBy | Unique email associated with this User |
createdBy | |
taskCount | |
targetGuid |