Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Live Search | ||||||||
---|---|---|---|---|---|---|---|---|
|
The Users and Accounts API feed allows you to integrate User and Account information with other employee and customer-based software such as HRMS and CRM.
Purpose of the API Feed
This Users and Accounts API Feed could be used to connect your accessplanit system to other employee or customer systems, such as your CRM system to sync your customer contacts, or your HR system to sync your employees.
Connecting your systems 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 systems!
Fields Available in the API Feeds
There are three feeds included for Users and Accounts data
Each of these three feeds can be used to read data from, send updates to, and create new records in your accessplanit system.
Users
This feed is used for accessing the details of Users within the database.
Field | GET (Read) | PUT (Update) | POST (Create new) | Validation |
---|---|---|---|---|
User ID | Image Modified | Image Modified | Image Modified | Max 10 chars |
Forenames | Image Modified | Image Modified | Image Modified Mandatory | |
Middle Name | Image Modified | Image Modified | Image Modified | |
Surname | Image Modified | Image Modified | Image Modified Mandatory | |
External ID | Image Modified | Image Modified | Image Modified | |
Email Address | Image Modified | Image Modified | Image Modified | Valid email address format |
Phone Number | Image Modified | Image Modified | Image Modified | |
Job Title | Image Modified | Image Modified | Image Modified | |
Marketing Opt-in | Image Modified | Image Modified | Image Modified | |
Address | Image Modified | Image Modified | Image Modified | |
Town | Image Modified | Image Modified | Image Modified | |
County | Image Modified | Image Modified | Image Modified | |
Country | Image Modified | Image Modified | Image Modified | Y - must exist in the system |
Postcode | Image Modified | Image Modified | Image Modified | |
Main Account ID | Image Modified | Image Modified | Image Modified Mandatory | Must validate against existing Company |
Main Account Name | Image Added | Image Added | Image Added | |
Status | Image Added | Image Added | Image Added | |
Preferred Method of Contact | Image Added | Image Added | Image Added | |
Gender | Image Added | Image Added | Image Added | |
Title (Mr, Mrs, etc.) | Image Added | Image Added | Image Added | |
Date of Birth | Image Added | Image Added | Image Added |
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 (Read) | PUT (Update) | POST (Create new) | 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 (Read) | PUT (Update) | POST (Create new) | Validation |
---|---|---|---|---|
Account Group ID | ||||
Account Group Label Name | Mandatory |
Connecting to the API
DISCLAIMER: By using accessplanit APIs, you agree to our terms of use.
To gain access to the Users and Accounts API Feed please speak to the CSM team at accessplanit on csm@accessplanit.com
On this page:
Table of Contents |
---|