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 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 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 platform.
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
N
Max 10 chars
Forenames
Mandatory
Middle Name
Surname
Mandatory
External ID
Email Address
Valid email address format
Phone Number
Job Title
Marketing Opt-in
Address
Town
County
Country
Y - must exist in the platform already
Postcode
Main Account ID
Mandatory
Must validate against existing Company
Main Account Name
Status
Preferred Method of Contact
Gender
Title (Mr, Mrs, etc.)
Date of Birth
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
N
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
N
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