When calling an endpoint of our API, you'll get a specific response depending on the status of the request and the endpoint you called.
The envelope is always the same with the following structure:
"data": Data Object,
"error": Error Object,
"pagination": Pagination Object
true: The request was successful. The
errorobject will be an empty dict
false: The request was not successful. More information about the error can be found in the
This object will contain the useful data in case of a sucessful request. It will always contain user_id or account_id (Except for the List Users response) and all the other fields will be dynamic, according to the endpoint you called.
country: The country of the user's account.
platform: The platform of the user's account.
message: Information provided in case of a failed connection.
profile: The user's profile. See the Profile section for more information.
earnings: The user's earnings. See the Earnings section for more information.
accounts: The user's accounts.
users: A company's users.
This object will contain information about the error in case of a failed request.
To get more information about potential errors, see the Errors section.
This object will only be included in the response for the endpoints where pagination is used, like:
The default value for
100, unless indicated otherwise in the request payload.