This page will help you get started with the API.

Welcome to version 1 of topboard API. Below you will find a current list of the available methods to access meetings, projects, minutes, etc. of your organization through our API.

If you need help or support, please contact us at [email protected]

Authentication

All API requests require authentication. To authenticate, you need an API key. You can find your API key on your organization's setting.

API Key sent as a HTTP header

curl -H "Authorization: X-TB-API-KEY <YOUR-TOPBOARD-API-KEY>" https://topboard.ch/meetings

Pagination

Requests that return multiple items (like index) will be paginated to 30 items. You can specify further pages with the page parameter. For some resources, you can also set a custom page size up to 500 with the per_page parameter.

curl "https://topboard.ch/api/v1/meetings?page=2&per_page=100"

Note that page numbering is 1-based and that omitting the page parameter will return the first page.

Link Header

The Link header includes information about pagination:

Link: <https://topboard.ch/api/v1/meetings?page=2>; rel="next",
      <https://topboard.ch/api/v1/meetings?page=5>; rel="last"

The possible rel values are:

  • next The link for the next page of results.
  • prev The link previous page of results.
  • first The link for the first page of results.
  • last The link for the last page of results.

It's advised to form calls with Link header values instead of constructing your own URLs.

Total Header

The response header also contains Total parameter which shows total number of items:

Total: 350