Management API

Base Resource URL:



Provides access to customers registered within the system.

Available sub-resources:

Resource URL Description
https://[server-name]/api/v01/customers/[customer-id]    Provides access to configuration settings for the specified customer.

Supported Actions:

Method:  PUT       Implicit:  Yes       Returns:  Customer *      
Consumes:  json, xml, query  Produces:  json, xml, query 
Creates a customer.

# Name Type Required Default Description
01 object Customer * Yes Represents information about the customer.

Response Codes: view

Method:  GET       Implicit:  Yes       Returns:  Customer[] *      
Consumes:  query  Produces:  json, xml 
Returns a list of available customers based on specified search criteria.

# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned to the customer from the search result of a web search.
02 limit Integer No 20 Maximum number of records to load per single search web call made by the customer.
03 firstName String(255) No The first name of the customer.
04 lastName String(255) No The last name of the customer.
05 organizationName String(255) No Name of the organization associated with the customer.

Response Codes: view