ParametersΒΆ

The table below contains all available parameters for the API. Parameters in bold are required, while parameters in italics are optional.

Parameter Description
api The API version to use; must be 3 to use API version 3.
format The format to use for the response; can currently only be json. See Handling responses for more information on the available formats.
authentication_type The type of authentication to use for this request; can be either user or application. See Authentication for more information.
customer The effective customer to use for this request. Some actions require an effective customer to be specified. It is not allowed to specify both a customer and an account.
account The effective account(s) to use for this request. Some actions require an effective account to be specified. It is not allowed to specify both an account and a customer.
user The user to use for user authentication. See Authentication for more information.
application The application to use for application authentication. See Authentication for more information.
session The active session token, when using a session within application authentication. See Authentication for more information.
timestamp The timestamp of this request, included in the signature. See Authentication for more information.
signature The signature calculated for this request. See Authentication for more information.
timezone If you want to use a different timezone for this request (both for input and output), you can specify it in this parameter. It should be a valid timezone string.