User API Feeds

On this page:

1 Purpose of the API Feeds
2 Fields Available in the API Feeds
- 2.1 Users
- 2.2 Companies
- 2.3 Company Groups
3 Connecting to the API

Useful Helpguide Links

Integrate with the accessplanit API v1 Feeds - Overview

Course API Feeds

Financial API Feeds

Useful External Links

API Terms of Use l accessplanit

https://documenter.getpostman.com/view/10924757/2sA3kYgzB9

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.

Field	PUT (Update)	POST (Create new)	Validation for PUT & POST
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	Mandatory	Max characters 50
Middle Names			Max characters 250
Surname	Mandatory	Mandatory	Max characters 40
Status			n/a
Email Address			Must be in an email address format Max characters 80
Date of Birth			Date (i.e. `"1985-01-12"`) Date must be in the past
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			n/a
Main Account / Company ID	Mandatory	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)
National Insurance Number
Main Contact (from their Main Account)
Account Manager (from their Main Account)
User Based Custom Fields			Validation on POST & PUT requests are subject to custom field type used, for example a valid date must be provided for Custom Fields with a type of ‘date’

Here are some example filters that you are able to use with your Users API Feed:

Only include users that have opted into marketing:

{{apiroot}}/users?MarketingOptIn=true

Only include a specific User

{{apiroot}}/users?UserID=TaShall

Only include users updated since 20th August 2022

{{apiroot}}/users?DateUpdated=gt:2022-08-20T00:00:00

Only include users born between 1990 and 2010

{{apiroot}}/users?DateOfBirth=gt:1990-01-01T00:00:00&lt:2010-12-31T23:59:59

Only include users that have a title of "Dr"

{{apiroot}}/users?Title=”Dr”

Only include users with a status of “Locked”

{{apiroot}}/users?Status=Locked

Only include users that do not have an email address

{{apiroot}}/users?EmailAddress=NULL

Only include users that have a middle name

{{apiroot}}/users?MiddleNames=not:NULL

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.

Field	GET (Read)	PUT (Update)	POST (Create new)	Validation for PUT & POST
Account ID				Max characters 10
Name		Mandatory	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				n/a
Account Group IDs	Via Links		Mandatory	Must validate against existing Company Group
Account Based Custom Fields				Validation on POST & PUT requests are subject to custom field type used, for example a valid date must be provided for Custom Fields with a type of ‘date’

Here are some example filters that you are able to use with your Companies API Feed:

Only include a specific Account

{{apiroot}}/companies?CompanyID=TEST01

Only include Accounts updated since 20th August 2022

{{apiroot}}/companies?DateUpdated=gt:2022-08-20T00:00:00

Only include Accounts that do not have an external ID

{{apiroot}}/companies?ExternalID=NULL

Only include Accounts that have an email address

{{apiroot}}/companies?EmailAddress=not:NULL

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	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.

Knowledge Base