paymo.auth.checkToken

Returns the credentials attached to an authentication token.

Authentication

This method requires authentication.

Arguments

api_key (Required)
Your application key. See here for more details.
auth_token (Required)
Authentication token received upon login.

Example Response

<?xml version="1.0" encoding="UTF-8"?> <response status="ok"> <token>ccdf3864e2fa9089f9eca4fc7a48ea0a</token> <user id="1279" username="johndoe" realname="John Doe" isadmin="0" /> </response>

Error Codes

101: Unknown API method
The requested method was not found.
102: Unknown response format
The requested response format was not found.
103: Invalid API Key
The API key passed was not valid.
104: Invalid auth token / Login failed
The login details or auth token passed were invalid.
105: Insufficient permissions
The user making the method call did not have the required permissions.
106: Service currently unavailable
The service is temporarily unavailable.
107: Too many requests for this API key
The application has reached the limit for number of API calls during a specific time period. Wait a bit and try again.