User API Feeds

Search for a solution

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.

It is possible to create and update Users via the feed, please see the below table to view which fields can be used when creating and updating Users.

It is not yet possible to filter the results of GET request for Users, other than specifying the user’s ID via

  • {{apiroot}}/users/[user ID]

Field

GET
(Read)

GET
(Filter)

PUT
(Update)

POST
(Create new)

Validation

User ID

Max characters 10

Title (Mr, Mrs, etc.)

Must exist as a title in your accessplanit platform (i.e. Mr, Ms, Dr, Mx)

Forenames

Mandatory

Max characters 50

Middle Names

Max characters 250

Surname 

Mandatory

Max characters 40

Status

n/a

Email Address 

Must be in an email address format

Max characters 80

Date of Birth

Date Time

Date must be in the future

Phone Number 

Must be a valid phone number, extensions are accepted

Max characters 25

Mobile Number

Max characters 25

Job Title

Max characters 255

Marketing Opt-in 

True or False

Address

Max characters 150

Town 

Max characters 60

County 

Max characters 30

Postcode 

Max characters 10

Country 

Must be a valid country

External ID 

Max characters 50

Date Updated
(coming soon)

n/a

Main Account / Company ID

 Mandatory

Must validate against an existing Account in your accessplanit platform

Main Account / Company Name

Main Account should be created and updated using MainCompanyID

(Preferred) Method of Contact

Must exist as a method of contact in your accessplanit platform (i.e. Email, Phone, SMS)

Gender

Must exist as a gender in your accessplanit platform (i.e. Female, Male, Unspecified, Other)

User Based Custom Fields

Subject to custom field type used


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.

It is possible to create and update Accounts via the feed, please see the below table to view which fields can be used when creating and updating Accounts.

It is not yet possible to filter the results of GET request for Accounts, other than specifying the account’s ID via

  • {{apiroot}}/companies/[company ID]

Field

GET
(Read)

GET
(Filter)

PUT
(Update)

POST
(Create new)

Validation

Account ID   

Max characters 10

Name

Mandatory

Max characters 255

Main Contact User ID

Must validate against an existing User in your accessplanit platform

Email Address

Must be in an email address format

Max characters 80

External ID

Max characters 50

Address

Max characters 150

Town

Max characters 60

County

Max characters 50

Postcode

Max characters 15

Country

Must be a valid country

Phone

Must be a valid phone number, extensions are accepted

Max characters 25

Date Updated
(coming soon)

n/a

Account Group IDs


Via Links

Mandatory

Must validate against existing Company Group

Account Based Custom Fields

Subject to custom field type used


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.

It is possible to create and update Account Groups via the feed, please see the below table to view which fields can be used when creating and updating Account Groups.

It is not yet possible to filter the results of GET request for Accounts, other than specifying the account group’s ID via

  • {{apiroot}}/companygroup/[company group ID]

Field

GET
(Read)

GET
(Filter)

PUT
(Update)

POST
(Create new)

Validation

Account Group ID

Max characters 10

Account Group Label Name


Mandatory

Max characters 50


Connecting to the API

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.