The Surfboard API lets you export data from your Surfboard account into data analytics tools. Easily combine WFM data with other sources to perform detailed reports, or simply automate timesheet exports to your billing system.
What is an API?
An API is like a menu at a restaurant. It tells different computer programs how to ask for things from each other. Just like you use a menu to order food, programs use an API to request information or actions from other programs. The API explains what you can ask for, how to ask for it, and what kind of answer you'll get back.
What data can I get from the Surfboard API?
The details of our API can be found on our documentation site.
How can I connect to the API?
To access the API, reach out to your Customer Success Manager who will provide you securely with an access token which is valid for one year.
This token should be included in any requests you make to Surfboard’s API in the Authorization header in 'bearer token' format, like so:
curl 'https://api.teamsurfboard.com/...' \ -H 'Authorization: Bearer ...'
API requests without authentication will fail.
How do I use the API?
If you are unfamiliar with APIs we recommend reaching out to the IT or engineering team in your business for support.
Zapier has a helpful guide to understanding the basics of APIs and how to use them. Read it here.