Customer Forum

How to provide the authorization to the Workbooks APIs to retrieve details

KPS Posted: 2019-02-19 10:17


I would like to know how to provide authorization to Workbooks APIs in order to fetch the details. I've requested to the login api to fetch the session details which contain s 'authenticity_token' and 'session_id' in the response. How this value or the session_id value could be used to authorize the API request. for example, I would need to request for the API /admin/users.api.

Content-Type: application/json

I've used the header authenticity_token: xxxxxx in the request. However, I'm getting 401 error.

Please suggest.

Sam (Workbooks Online) Posted: Tue, 19.02.2019 - 21:40

HI Krishna,

Most people developing an integration with Workbooks will authenticate their session through an API Key. These can be generated from Start > Configuration > Email & Integration > API Keys. These can be owned by a User so will have the same Capabilities and Permissions as that User unless additional Capabilities are applied to the API Key.

We generally recommend setting the Access as User to be Automation as this will give full access to the system and will not run into issues such as expiring passwords.

Please let us know if you have any other questions regarding this.


KPS Posted: Wed, 20.02.2019 - 04:11

Hi Sam,

The use of API key for authenticating worked fine. Thanks for the support.

Jake Posted: Tue, 05.11.2019 - 16:41


Russ Posted: Wed, 11.03.2020 - 13:58

What needs to go in the header for the API Key as authenticity_token: is not working for me?

Gavin (Workbooks Online) Posted: Thu, 12.03.2020 - 10:41

HI Russ, 

I believe the answer to this query is located in our API Developers guide:

specifically in the 'Sessions, Login and Logout' section. 

Kind Regards,

Workbooks Support