The JobsEQ API is designed to allow users to run JobsEQ Analytics programmatically. With the exception of the Data Fetch API, it is not intended for retrieving bulk data. If you need large quantities of data at once, consider using one of our data products such as our Snowflake offering.

Licensing

Before proceeding, please review your JobsEQ service agreement for details on data use restrictions. All data must be sourced to JobsEQ.

Authentication

API Authentication can be handled one of three ways. We recommend using API Key Auth whenever possible.

1. API Key Auth - This is the most common and straightforward authentication type. Your API Key will be sent to you by your JobsEQ Sales Rep or the API Support team.
2. Username/Password Auth - Your SaaS username and password can be used to obtained a Bearer Token
3. HMAC Auth - Used when you need to access the JobsEQ API directly from client-side code. Contact the API Support Team for details.

🔒

Security Recommendation

Always keep your API keys and credentials secure. They should not be committed to public respositories or included in client-side code.

Read more in the Authentication section.

Region

Nearly all JobsEQ analytics require a region parameter. Region parameters are passed in the form of type/code pairs. For example, the type/code pair for the State of Ohio is:

{ "type": "State", "code": 39 }

Your region access is determined by your license. To obtain a list of licensed regions, use the /Regions endpoint.

Rate Limits

A rate limit is applied to all API requests. The specific rate limit level is determined by your license. When the rate limit is exceeded, JobsEQ will return an HTTP 429 error.

See the Rate Limits section for additional details.