Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Livesearch
spaceKeyHG
additionalpage excerpt
placeholderSearch for a solution
typepage

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

Image Removed

(tick)

Image RemovedN

(error)

Image Removed

(tick)

Max 10 chars

Forenames

Image Removed

(tick)

Image Removed

(tick)

Image Removed Mandatory

(tick) Mandatory

Middle Name

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Surname 

Image Removed

(tick)

Image Removed

(tick)

Image Removed Mandatory

(tick) Mandatory

External ID 

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Email Address 

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Valid email address format

Phone Number 

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Job Title

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Marketing Opt-in 

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Address

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Town 

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

County 

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Country 

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Y - must exist in the platform already

Postcode 

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Main Account ID

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick) Mandatory

Must validate against existing Company

Main Account Name

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Status

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Preferred Method of Contact

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Gender

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Title (Mr, Mrs, etc.)

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Date of Birth

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

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   

Image Removed

(tick)

Image RemovedN

(error)

Image Removed

(tick)

Name

Image Removed

(tick)

Image Removed

(tick)

Image Removed Mandatory

(tick) Mandatory

Email Address

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Valid email address format

Main Contact User ID

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Must validate against existing User ID

External ID

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Address

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Town

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

County

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Country

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Postcode

Image Removed

(tick)

Image Removed

(tick)

Image Removed

(tick)

Account Group IDs

Image Removed

(tick)

Image Removed

(tick)

Image Removed Mandatory

(tick) 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

Image Removed

(tick)

Image RemovedN

(error)

Image Removed

(tick)

Account Group Label Name

Image Removed

(tick)

Image Removed

(tick)

Image Removed Mandatory

(tick) 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