Equus Software

The Equus Platform supports integrating with other systems by leveraging a new industry standard API.  The API accepts requests and sends responses in JSON and leverages JWT (JSON Web Tokens)…

Equus Platform API - Overview

The API Subscription Manager screen at the system level allows for API Subscribers to be created. It will default to show the API Subscribes tab. In order for users to access…

AssignmentPro API - Creating API Subscriber and generating authentication credentials

The security role(s) that should have the ability to configure the API functionality must have access to the &lt;API Subscription Manager&gt; screen.   On the Security Role Maintenance screen, grant a

AssignmentPro API - How to configure security role to access API Subscribers page

It is possible to regenerate both the GUID and Secret Key if the Secret Key is lost or compromised. Regeneration should only be done with the involvement of a technical resource (more…

AssignmentPro API - How to regenerate authentication credentials

Calls to the API are secured using JSON Web Tokens, which utilize the GUID and Secret Key configured in the API Subscription Manager screen. JWTs are constructed programmatically by external…

AssignmentPro API - How to access API technical documentation

While the Standard API is designed to enable getting information in and out of the Equus Platform in a consistent, structured manner, the systems that are making requests against it…

Equus Platform API - Webhook Overview

API Requests support using query string parameters in order to specify the type of value being provided in POST or PATCH requests, or the desired type of value to be…

AssignmentPro API - Lookup Fields

Special logic has been built in for country fields, so that the Display Name, 2 character, or 3 character ISO code can be provided in create or update requests without…

AssignmentPro API - Country Fields

Custom Fields are supported in the API. When enabled in AssignmentPro, Custom Fields will be available as attributes on their parent objects, like Assignment or Employee, for GET, POST and…

AssignmentPro API - Custom Fields

The API Subscription Manager screen allows for the configuration of System Profiles for Webhooks so that the parameters required by target systems to authenticate messages can be input on the screen.

AssignmentPro API - How to create a Webhook System Profile

Boolean fields will always return a non-string “true” or “false” in responses, and the API can accept different variations of true or false for create or update requests without needing…

AssignmentPro API - Boolean Fields

AssignmentPro API enables the exchange of information between AssignmentPro and other systems using API. The API Event History screen can be used to view log of each API event in…

AssignmentPro API - Viewing API Event History

API Overview

Find answers and get help from Intercom Support and Community Experts

Conversations you've started through the messenger will appear here.

No conversations created by you

Try using different keywords or checking for typos.

No conversations found

Title

This site employs cookies and other technologies that we and our third party vendors use to monitor and record personal information about you and your interactions with the site (including content viewed, cursor movements, screen recordings, and chat contents) for the purposes described in our Cookie Policy. By continuing to visit our site, you agree to our {websiteTermsLink}, {privacyPolicyLink} and {cookiePolicyLink}.

This site uses cookies and similar technologies ("cookies") as strictly necessary for site operation. We and our partners also would like to set additional cookies to enable site performance analytics, functionality, advertising and social media features. See our {cookiePolicyLink} for details. You can change your cookie preferences in our Cookie Settings.

We use cookies to make our site work and also for analytics and advertising purposes. You can enable or disable optional cookies as desired. See our {cookiePolicyLink} for more details.

Advertising cookies are set by our advertising partners to collect information about your use of the site, our communications, and other online services over time and with different browsers and devices. They use this information to show you ads online that they think will interest you and measure the ads' performance. Social media cookies are set by social media platforms to enable you to share content on those platforms, and are capable of tracking information about your activity across other online services for use as described in their privacy policies.

These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.

These cookies are necessary for the website to function and cannot be switched off in our systems.

These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site.

You have the right to opt out of the sale of your personal information. See our {cookiePolicyLink} for more details about how we use your data.

Your Privacy Choices

We use cookies to enhance your experience. You can customize your cookie preferences below. See our {cookiePolicyLink} for more details.

Cookie Settings

Empty Help Center

Uh oh. That page doesn’t exist.

Home

Search results

Disappointed

Neutral

Smiley

Thinking...

Searching through sources...

Analyzing...

Tickets submitted through the messenger or by a support agent in your conversation will appear here.