Returns a list of Boards as defined by the list of Board ids passed as part of the request query parameters.
TABLE OF CONTENTS
- URL Parameters
- Response
- Response Headers
- Definitions
- ModifiedBy
- Members[]
- Owners[]
- Viewers[]
- CardType[]
- Columns[]
- SubBoards[]
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
Curl
with optional parameters
HTTP
Curl
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
Sample Response
Status code: 200
JSON
Get Sample Request with Expand option
cUrl
Sample Response
Status code: 200
JSON
Definitions
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 positition 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 |
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