Get a list of API clients

GET
/apiclients

Roles

At least one of the roles below is required to access this endpoint

FullAccess
ApiClientAdmin
ApiClientReader

Parameters

NameTypeDescriptionPossible Values
searchstringWord or phrase to search for.---
searchOnarrayComma-delimited list of fields to search on.ID, AppName, DefaultContextUserName
sortByarrayComma-delimited list of fields to sort by.ID, AppName, DefaultContextUserName, !ID, !AppName, !DefaultContextUserName
pageintegerPage of results to return. Default: 1. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.---
pageSizeintegerNumber of results to return per page. Default: 20, max: 100.---
filtersobjectAny additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'---

Response Body

PropertyTypeFormatMax LengthPossible Values
Itemsarray---------
PropertyTypeFormatMax LengthPossible Values
ID
Read Only
string---------

ClientSecretstring---------

AccessTokenDurationintegerint32------
Activeboolean---------

AppNamestring---------
RefreshTokenDurationintegerint32------
DefaultContextUserNamestring---------

xpobject---------
AllowAnyBuyerboolean---------

AllowAnySupplierboolean---------

AllowSellerboolean---------

IsAnonBuyerboolean---------

AssignedBuyerCount
Read Only
integerint32------
AssignedSupplierCount
Read Only
integerint32------
OrderCheckoutIntegrationEventIDstring---------

OrderCheckoutIntegrationEventName
Read Only
string---------
MinimumRequiredRolesarray---------
MinimumRequiredCustomRolesarray---------
MaximumGrantedRolesarray---------
MaximumGrantedCustomRolesarray---------
Metaobject---------
PropertyTypeFormatMax LengthPossible Values
Pageintegerint32------
PageSizeintegerint32------
TotalCountintegerint32------
TotalPagesintegerint32------
ItemRangearray---------