Sitecore API catalog/OrderCloud/API clients

API clients

API clients represent applications or tools that need to interact with OrderCloud to send requests and receive data.

Operations

List API clients

Request

Security
OAuth2(Required scopes: FullAccessApiClientAdminApiClientReader)
Query
searchstring

Word or phrase to search for.

searchOnArray of strings

Comma-delimited list of fields to search on.

Items Enum:"ID""AppName""DefaultContextUserName"
sortByArray of strings

Comma-delimited list of fields to sort by.

Items Enum:"ID""AppName""DefaultContextUserName""!ID""!AppName""!DefaultContextUserName"
pageinteger

Page of results to return. When paginating through many items (> page 30), we recommend the "Last ID" method, as outlined in the Advanced Querying documentation.

Default:1
pageSizeinteger, <= 100

Number of results to return per page.

Default:20
filtersobject

An object or dictionary representing key/value pairs to apply as filters. Valid keys are top-level properties of the returned model or 'xp.???'

curl -i -X GET \
  'https://api.ordercloud.io/v1/apiclients?search=string&searchOn=ID&sortBy=ID&page=1&pageSize=20&filters=' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Bodyapplication/json
ItemsArray of objects(ApiClient)
Example:
[
  {
    "ID": "",
    "ClientSecret": "",
    "AccessTokenDuration": 0,
    "Active": false,
    "AppName": "",
    "RefreshTokenDuration": 0,
    "AnonymousTokenDuration": 0,
    "DefaultContextUserName": "",
    "xp": {},
    "AllowAnyBuyer": false,
    "AllowAnySupplier": false,
    "AllowSeller": false,
    "IsAnonBuyer": false,
    "AssignedBuyerCount": 0,
    "AssignedSupplierCount": 0,
    "OrderCheckoutIntegrationEventID": "",
    "OrderCheckoutIntegrationEventName": "",
    "OrderReturnIntegrationEventID": "",
    "OrderReturnIntegrationEventName": "",
    "AddToCartIntegrationEventID": "",
    "AddToCartIntegrationEventName": "",
    "MinimumRequiredRoles": [ … ],
    "MinimumRequiredCustomRoles": [ … ],
    "MaximumGrantedRoles": [ … ],
    "MaximumGrantedCustomRoles": [ … ]
  }
]
Metaobject(Meta)
Response
{
  "Items": [
    { … }
  ],
  "Meta": {
    "Page": 0,
    "PageSize": 0,
    "TotalCount": 0,
    "TotalPages": 0,
    "ItemRange": [ … ],
    "NextPageKey": "string"
  }
}