https://api.worqhat.com
domain. This is the only official domain that is applicable for all API Calls to the Application.
The WorqHat API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The API key you use to authenticate the request determines whether the request you are sending as a user is based on which Organization as all our Billings are rerouted to the Organization you are using the API keys for.
The WorqHat API doesn’t support bulk updates. You can work on only one object per request. The WorqHat API differs for every account as we release new versions and tailor functionality. These docs are customized to your version of the API.
If you’re using a version of the API that is older than the latest version, you may see older endpoints and outdated response schemas. We recommend that you use the latest version of the API whenever possible. We release new versions of the API frequently, so you may need to update your API integration periodically. We also send out email notifications about new versions of the API. You can subscribe to these notifications in your WorqHat account settings.
Base URL for all API calls
$workspace is the name of your Workspace. You can find the name of your Workspace in the URL of your Workspace. For example, if your Workspace URL is https://myworkspace.worqhat.app, then your Workspace name is myworkspace.
https://example.com
, you’ll need to add example.com
to the Allowed Domains section.Authorization Bearer <YOUR_API_KEY>
tokens to authenticate API requests.
WORQHAT_API_KEY
with every request that you send. Additionally, you have the option to set a per-request key, which is often useful for Connect applications that use multiple API keys during the lifetime of a process. Methods on the returned object reuse the same API key.
Finally, it’s important to note that all API requests must be made over HTTPS. Calls made over plain HTTP will fail, and API requests without authentication will also fail. By following these best practices, you can help keep your API requests secure and prevent unauthorized access to your data.