GET boards

Gets the list of user's boards

Request

URL ( requires authentication )

https://api.crexi.com/boards?userCanAddAssetsOnly={userCanAddAssetsOnly}&assetId={assetId}

Parameters

assetId

integer

If assetId is passed return AssetIsSaved as true if that asset is saved to that board

Optional

userCanAddAssetsOnly

boolean

If set to true, returns boards where the current user has admin access only

Optional

Default value is False

Response

Details

Returns an HTTP 200 OK and a list of boards. Returns 400 Bad Request and an error message otherwise.

Data fields

AssetIsSaved

boolean

Id

integer

IsFavorite

boolean

Name

string

NumberOfAssets

integer

ThumbnailUrl

string

UserCanDelete

boolean

UserCanEdit

boolean

UserCanLeave

boolean

UserCanManageUsers

boolean

Users

Collection of BoardUserData

Example

JSON

[
  {
    "AssetIsSaved": false,
    "Id": 1,
    "IsFavorite": false,
    "Name": "Awesome Properties",
    "NumberOfAssets": 5,
    "ThumbnailUrl": "http://qwerty.qwe/board/12345/tn.jpg",
    "UserCanDelete": false,
    "UserCanEdit": true,
    "UserCanLeave": true,
    "UserCanManageUsers": true,
    "Users": [
      {
        "Id": 1,
        "IsInvited": false,
        "Name": "Nick Banson",
        "ThumbnailUrl": "http://qwerty.qwe/user/12345/tn.jpg",
        "UserId": 100
      },
      {
        "Id": 2,
        "IsInvited": true,
        "Name": "johnanderson@test.com",
        "ThumbnailUrl": "http://qwerty.qwe/user/54321/tn.jpg"
      }
    ]
  }
]