Date: Thu, 28 Mar 2024 08:16:20 +0000 (UTC) Message-ID: <1706422988.21.1711613780341@08c5433572e7> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_20_957396206.1711613780341" ------=_Part_20_957396206.1711613780341 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
On this page:
Useful Helpguide Links
Useful External Links
https://www.acce= ssplanit.com/api-terms-of-use
https://documenter.getpostman.com/view/10924757/SzYexcAy?= version=3Dlatest#intro
The Users API feed endpoints allows you to integrate User and Ac= count information with other employee and customer-based software = such as HRMS and CRM.
The feed is available if you have the API Feeds module. P= lease speak to your CSM to find out more about this module= .
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 syst= em 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 h= eadache of managing multiple pieces of software!
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, an= d updating, the tables below explain what actions are available for the fie= lds in each feed.
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 b= elow table to view which fields can be used when creating and updating User= s.
Field |
GET |
GET |
PUT |
POST |
Validation for PUT & POST |
---|---|---|---|---|---|
User ID |
= p> |
= p> |
= p> |
Max characters 10 |
|
Title (Mr, Mrs, etc.) |
= p> |
= p> |
= p> |
= p> |
Must exist as a title in your accessplanit platform (i.e. Mr, Ms, Dr, Mx= ) |
Forenames |
= p> |
= p> |
M= andatory |
M= andatory |
Max characters 50 |
Middle Names |
= p> |
= p> |
= p> |
= p> |
Max characters 250 |
Surname |
= p> |
= p> |
M= andatory |
M= andatory |
Max characters 40 |
Status |
= p> |
= p> |
n/a |
||
Email Address |
= p> |
= p> |
= p> |
= p> |
Must be in an email address format Max characters 80 |
Date of Birth |
= p> |
= p> |
= p> |
= p> |
Date (i.e. Date must be in the past |
Phone Number |
= p> |
= p> |
= p> |
= p> |
Must be a valid phone number, extensions are accepted Max characters 25 |
Mobile Number |
= p> |
= p> |
= p> |
= p> |
Max characters 25 |
Job Title |
= p> |
= p> |
= p> |
= p> |
Max characters 255 |
Marketing Opt-in |
= p> |
= p> |
= p> |
= p> |
True or False |
Address |
= p> |
= p> |
= p> |
= p> |
Max characters 150 |
Town |
= p> |
= p> |
= p> |
= p> |
Max characters 60 |
County |
= p> |
= p> |
= p> |
= p> |
Max characters 30 |
Postcode |
= p> |
= p> |
= p> |
= p> |
Max characters 10 |
Country |
= p> |
= p> |
= p> |
= p> |
Must be a valid country |
External ID |
= p> |
= p> |
= p> |
= p> |
Max characters 50 |
Date Updated |
= p> |
= p> |
n/a |
||
Main Account / Company ID |
= p> |
= p> |
M= andatory |
&n= bsp;Mandatory |
Must validate against an existing Account in your accessplanit platform<= /p> |
Main Account / Company Name |
= p> |
= p> |
Main Account should be created and updated using MainCompanyID |
||
(Preferred) Method of Contact |
= p> |
= p> |
= p> |
Must exist as a method of contact in your accessplanit platform (i.e. Em= ail, Phone, SMS) |
|
Gender |
= p> |
= p> |
= p> |
Must exist as a gender in your accessplanit platform (i.e. Female, Male,= Unspecified, Other) |
|
User Based Custom Fields |
= p> |
= p> |
= p> |
Validation on POST & PUT requests are subject to custom field type u= sed, for example a valid date must be provided for Custom Fields with a typ= e of =E2=80=98date=E2=80=99 |
Here are some example filters that you are able to use with your Users A= PI Feed:
Only include users that have opted into marketing:
{{apiroot}}/users?MarketingOptIn=3Dtrue
Only include a specific User
{{apiroot}}/users?UserID=3DTaShall
Only include users updated since 20th August 2022
{{apiroot}}/users?DateUpdated=3Dgt:2022-08-20T00:00:00
Only include users born between 1990 and 2010
{{apiroot}}/users?DateOfBirth=3Dgt:1990-01-01T00:00:00<:2010-12-31= T23:59:59
Only include users that have a title of "Dr"
{{apiroot}}/users?Title=3D=E2=80=9DDr=E2=80=9D
Only include users with a status of =E2=80=9CLocked=E2=80=9D
{{apiroot}}/users?Status=3DLocked
Only include users that do not have an email address
{{apiroot}}/users?EmailAddress=3DNULL
Only include users that have a middle name
{{apiroot}}/users?MiddleNames=3Dnot:NULL
This feed is used for accessing the details of Accounts within the datab= ase. Accounts are used to group Users and manage their employment records.<= /p>
It is possible to create and update Accounts via the feed, please see th= e below table to view which fields can be used when creating and updating A= ccounts.
Field |
GET |
GET |
PUT |
POST |
Validation for PUT & POST |
---|---|---|---|---|---|
Account ID |
= p> |
= p> |
= p> |
Max characters 10 |
|
Name |
= p> |
= p> |
M= andatory |
M= andatory |
Max characters 255 |
Main Contact User ID |
= p> |
= p> |
= p> |
= p> |
Must validate against an existing User in your accessplanit platform = |
Email Address |
= p> |
= p> |
= p> |
= p> |
Must be in an email address format Max characters 80 |
External ID |
= p> |
= p> |
= p> |
= p> |
Max characters 50 |
Address |
= p> |
= p> |
= p> |
= p> |
Max characters 150 |
Town |
= p> |
= p> |
= p> |
= p> |
Max characters 60 |
County |
= p> |
= p> |
= p> |
= p> |
Max characters 50 |
Postcode |
= p> |
= p> |
= p> |
= p> |
Max characters 15 |
Country |
= p> |
= p> |
= p> |
= p> |
Must be a valid country |
Phone |
= p> |
= p> |
= p> |
= p> |
Must be a valid phone number, extensions are accepted Max characters 25 |
Date Updated |
= p> |
= p> |
n/a |
||
Account Group IDs |
Via Links |
M= andatory |
Must validate against existing Company Group |
||
Account Based Custom Fields |
= p> |
= p> |
= p> |
Validation on POST & PUT requests are subject to custom field type u= sed, for example a valid date must be provided for Custom Fields with a typ= e of =E2=80=98date=E2=80=99 |
Here are some example filters that you are able to use with your Compani= es API Feed:
Only include a specific Account
{{apiroot}}/companies?CompanyID=3DTEST01
Only include Accounts updated since 20th August 2022
{{apiroot}}/companies?DateUpdated=3Dgt:2022-08-20T00:00:00
Only include Accounts that do not have an external ID= p>
{{apiroot}}/companies?ExternalID=3DNULL
Only include Accounts that have an email address
{{apiroot}}/companies?EmailAddress=3Dnot:NULL
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 upda= ting Account Groups.
It is not yet possible to filter the results of GET request for Accounts= , other than specifying the account group=E2=80=99s ID via
{{apiroot}}/companygroup/[company group ID]
Field |
GET |
GET |
PUT |
POST |
Validation |
---|---|---|---|---|---|
Account Group ID |
= p> |
= p> |
= p> |
Max characters 10 |
|
Account Group Label Name |
= p> |
M= andatory |
<= br> Mandatory |
Max characters 50 |
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.