Top

Troubleshooting API issues

  • all plans
Follow

Testing API calls

Before anything else, try a request and see the response. Follow the below steps:

  • Open our full API documentation and locate the endpoint you wish to use, e.g. /jobs
  • Select the programming language you are using
  • In the authentication section, input Bearer followed by a space and then followed by the API key from the Integrations page
  • In the URL section, enter your Workable subdomain
  • Once ready click Try it and a response will expand

mceclip2.png

  • To add more filtering (state, limit) navigate to the query params section and input the values, e.g. below are the params for the /jobs endpoint

mceclip1.png

If you receive 200 OK (green dot) this means that everything works as expected. Otherwise, the dot will turn red and a descriptive error will appear to reveal the nature of the issue (authorization, wrong subdomain, etc). 

 

Common issues/errors

401 Unauthorized error

This probably means that your API key was not added correctly. Make sure you add a space between Bearer and your API key.

 

429 error - 'You have exceeded the rate limits'

The request limit is 10 requests per 10 seconds. Make sure you implement your request accordingly.

 

CORS policy when using Javascript or jquery

Our API’s purpose is mostly for server-to-server communication and for this reason we do not support or encourage using it from the web browser (AJAX calls through javascript).  

If it is necessary to access from the browser, there are alternate public endpoints that can be accessed through JSONP if you only need to access job information:

curl -L GET 'https://www.workable.com/api/accounts/<account_subdomain>?details=true'
curl -L GET 'https://www.workable.com/api/accounts/<account_subdomain>/locations'
curl -L GET 'https://www.workable.com/api/accounts/<account_subdomain>/departments'

Your account subdomain is the first part of the URL you see when signed in to Workable. The part “?details=true” means that you also want to fetch the job descriptions. The last two endpoints will fetch all locations and departments respectively. 

Related articles