Page Comparison

Live Search

spaceKey	HG
additional	page excerpt
placeholder	Search for a solution
type	page

← Knowledge Base Homepage

← Plug-ins and Integration Homepage

← Information for your Web Developers Homepage

The Users and Accounts API feed

On this page:

Table of Contents

Useful Helpguide Links

API Feeds - Overview

Course API Feeds

Financial API Feeds

Useful External Links

https://www.accessplanit.com/api-terms-of-use

https://documenter.getpostman.com/view/10924757/SzYexcAy?version=latest#intro

Info
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

FeedThis and Accounts Feed could feeds included for Users and Accounts data can be used to read data from, send updates to, and create new records in your accessplanit platform

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	GET (Read)	GET (Filter)	PUT (Update)	POST (Create new)	Validation for PUT & POST
User ID					Max

10 charsMiddle NameExternal ID

Valid

Postcode

Y - must exist in the platform already

Company

Status

Preferred

Date of Birth

Title (Mr, Mrs, etc.)

Must exist as a gender in your accessplanit platform (i.e. Female, Male, Unspecified, Other)
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)	GET (Filter)	PUT (Update)	POST (Create new)	Validation for PUT & POST
Account ID					Max characters 10
Name			Mandatory

Email Address

Valid email address format IDPostcode

On this page:

toc

	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

Note
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

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

	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

Mandatory	Max characters 255
Main Contact User ID					Must validate against an existing User

	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

Versions Compared

Old Version 15

New Version Current

Key

Purpose of the API

Feeds

Fields Available in the API Feeds

Users

Companies

Company Groups

Connecting to the API