Axis REST API

This documentation identifies the data type for each parameter you send to an endpoint. Each endpoint reference page will include the parameters that can be sent along with the data type. The data types are as follows:

(string)

This is a string of alphanumeric characters. Some fields have a specific minimum and maximum number of characters which are indicated when applicable.

(int)

This is a numeric value. Some fields have a specific minimum and maximum value which are indicated when applicable.

(date8)

This is a date in the format YYYYMMDD, for example 20250615

(user-search-phrase)

This is a field-name=value pair, or a series of field-name=value pairs separated by commas, where the = can be one of several comparison operators (see below).

Here are some examples:

user is in state of nj: state=nj
users email address contains jtsupply.com: email~jtsupply.com
users manager is record id 12, user is in the salesteam usergroup, and user is in branch id 50:
manager_id=12,usergroup~salesteam,branch_id=50

The field-names available for compare strings are as follows:

(int)
id, manager_id, org_id, branch_id

(string)
username first_name, last_name, email, middle_init, company, address, city, state, zip, phone, custom1 > custom 15, localization, role, usergroup

(date8)
date_start, date_expire

Comparison Operators:

= means equals

!= means does not equal

~ means contains (with 1 exception - see below)

!~ means does not contain (with 1 exception - see below)

• usergroup uses ~ and !~ as 'are/are not in' a usergroup
• When using multiple field-name/value pairs, the lookup is treated as condition 1 and condition 2 and condition 3 etc.