API Key Objects

List API Keys

GET /(company_code)/v2/aol/apikey

Get list of available API Keys

Request Headers:
 
  • Authorization – Bearer <session_token>, or Signature <signature>
Response JSON Object:
 
  • status (string) – success or error
  • data (array) – API key data objects
  • error_code (string) – (Optional) If status is error: one of error codes listed below

API key data fields

Each object in data response array has the following fields:

Field name Type Description
name string API key name
comment string API key comment
enabled_flag boolean Flag indicating whether API key is enabled or invalid

Error codes used

  • auth.apikey.missing
  • auth.apikey.invalid
  • auth.header.missing
  • auth.header.invalid
  • auth.token.invalid
  • auth.token.expired
  • auth.session.invalid
  • auth.user.restricted
  • auth.user.closed
  • auth.user.denied
  • auth.restricted

See Error Codes for details.