API Authentication, Limits & Best Practices

Every endpoint requires an API Key. You will receive an HTTP 403 Forbidden error if attempting to access any endpoint without a valid API key.

Obtaining an API Key

If you are already working with Wagestream, your Client Success Manager (PSM) will give you your API key. If you've lost it, contact [email protected].

If you are a developer and would like more information, you can contact us through Intercom or email [email protected].

How to use your API key

You can log into the developer portal in the top right, and all of the code examples will be pre-filled with your API Key.

If you want to write your own code, simply include an HTTP header with all requests:

x-api-key: YOURAPIKEYHERE

Limits

Wagestream operates at a standard API limit of 300 requests per day. This is per client, not per endpoint.

Wagestream recommends batching data and sending a list of items, rather than sending data individually. For example, sending 30 shifts in one API every 15 minutes rather than sending 1 shift every one minute.

If the limit of 300 doesn't sound like it will work for you, let us know and we can look at other plans.

Best Practices

If you will be sending Wagestream changes only, we recommend having a regular full data sync (at least once per day) to account for any failures that may occur. For example, if an employee change (i.e. email change) fails to send, it is mitigated by the next full sync of data that is due to send.