Skip to main content

How to get access to our API

This guide explains how to get access to our API, so you can integrate Workfeed with your own systems.

If you would like to integrate Workfeed with a system we do not already have an integration for, you are always welcome to send us a request.

We are always interested in expanding our range of integrations and partners if it creates value for our customers.

Integrate with a system you built yourself

If you want to integrate Workfeed with a system you built yourself, you can use our open API. Access to the open API requires our Pro+ plan.

How to access the API

Under 'Settings' > 'Integrations' > 'Workfeed API', you can generate an API key yourself. Simply give the key an internal name so it is easy to recognize later.

You will also find our documentation here, so you can easily get started with building your integration. The documentation can also be accessed here
https://docs.workfeed.io/

If the API key is no longer needed, you can revoke it using the three dots next to the key.

FAQ

  1. Can I use the open API on all plans?

    No, access to the open API requires our Pro+ plan. Read more about our plans and how to change your plan here.

  2. Can I revoke an API key?
    Yes, you can easily revoke an API key by clicking the three dots next to the key.

  3. Can I get a read-only API key?

    No. Our API key is read/write, so the integration can retrieve, create, edit, and delete elements such as shifts, employees, leave, departments, roles, tags, transactions, and table bookings.

Did this answer your question?