Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Live Search | ||||||||
---|---|---|---|---|---|---|---|---|
|
Info |
---|
The Users API feed endpoints allows you to integrate User and Account information with other employee and customer-based software such as HRMS and CRM. |
The feed is available if you have the API Feeds module. Please speak to your CSM to find out more about this module.
Purpose of the API Feeds
The Users API Feeds can be used to connect your accessplanit platform to other employee or customer platforms, such as your CRM system to sync your customer contacts, or your HR system to sync your employees.
Connecting your platforms and syncing the data between them removes the need for double data entry, reduces the risk of human error and eases the headache of managing multiple pieces of software!
Fields Available in the API Feeds
There are three endpoints available for User & Account data, please see the below tables for the data that is available in each.
Each of these three feeds have different levels of reading, creating, and updating, the tables below explain what actions are available for the fields in each feed.
Users
This feed is used for accessing the details of Users within the database.
Field | GET | GET | PUT | POST | Validation | |||||
---|---|---|---|---|---|---|---|---|---|---|
User ID |
| Max 10 chars | ||||||||
Title (Mr, Mrs, etc.) | ||||||||||
Forenames |
| Mandatory | ||||||||
Middle NameNames |
| |||||||||
Surname |
| Mandatory | ||||||||
External ID Status | ||||||||||
Email Address | Valid email address format | |||||||||
Date of Birth | ||||||||||
Phone Number | ||||||||||
Mobile Number |
|
|
| |||||||
Job Title | ||||||||||
Marketing Opt-in | ||||||||||
Address | ||||||||||
Town | ||||||||||
County | ||||||||||
Postcode | ||||||||||
Country | Y - must exist in the platform already | |||||||||
Postcode External ID |
| |||||||||
Date Updated |
|
|
|
| ||||||
Main Account / Company ID | Mandatory | Must validate against existing Company | ||||||||
Main Account / Company Name | Status |
| Preferred Main Account should be created and updated using MainCompanyID | |||||||
(Preferred) Method of Contact | ||||||||||
Gender | Title (Mr, Mrs, etc.) |
| ||||||||
Date of Birth | User Based Custom Fields |
|
|
Companies
This feed is used for accessing the details of Accounts within the database. Accounts are used to group Users and manage their employment records.
Field | GET | GET | PUT | POST | Validation |
---|---|---|---|---|---|
Account ID |
| ||||
Name |
| Mandatory | |||
Email Address |
| Valid email address format | |||
Main Contact User ID |
| Must validate against existing User ID | |||
External ID |
| ||||
Address |
| ||||
Town |
| ||||
County |
| ||||
Country |
| ||||
Postcode |
| ||||
Account Group IDs |
| Mandatory | Must validate against existing Company Group |
Company Groups
This feed is used for accessing the details of Account Groups within the database. Account Groups are used to categorise and group Accounts.
Field | GET | GET | PUT | POST | Validation |
---|---|---|---|---|---|
Account Group ID |
| ||||
Account Group Label Name |
| Mandatory |
Connecting to the API
Note |
---|
DISCLAIMER: By using accessplanit APIs, you agree to our terms of use. |
As the API Feeds are an additional module, please contact your assigned Customer Success Manager (CSM) to gain access to them for your integrations.
On this page:
Table of Contents |
---|