Skip to main content

Integrating with Workyard's API

Written by Dylan Sewell

Workyard's API is a token-authenticated REST API. An admin generates a key from within the Web App and any external system can then call it to read or write that org's data, no separate developer signup involved.

If you're interested in exploring what is possible to do using our Open API you can check out our developer docs:

Additionally, if you would like to generate an API token you can do this by accessing it by following the steps below:

  • Go to "integrations" in the Workyard desktop app

  • Click on "API Token"

  • Click "Generate API Token"



Prerequisites and getting a key:

  • The org's plan has to include API access — it's part of the Autopilot tier, so an org on Starter or Pro plan won't see it.

  • Only an Admin on the account can generate the key (Managers and Workers can't).

  • The token can be set to expire in up to 60 months, or never expire.

  • That token is a bearer token used in the Authorization header on every API request; there's no separate app-registration or approval step.



Data it can access (scoped to that org, permission-tiered by whether the token was generated by an Admin vs. a Manager-level key):

  • Employees (list, update, remove, invite)

  • Time cards (create, read, update, approve, notes, GPS activity segments)

  • Projects/job sites

  • Cost codes

  • Tasks & scheduling (including checklists, notes, notifications)

  • Time off requests

  • Customers (the org's own customer records)

  • Smart Forms (work form definitions and submissions)

  • Tags and file attachments

  • Basic org/profile info

Did this answer your question?