Root

Use / (root) to get basic information about the authenticated user and your API usage.

Request

GET /

Response

Field	Description
status	The HTTP status code for the request.
message	The HTTP response message for the request.
see	A link to the documentation for the current version of the API.
version	The version of the API you’re making requests to.
user	The user who authenticated this request: id is the user’s user_id, name is their full name, and email is their Appfigures username. This helps when you authenticate users with OAuth.
usage	Your API usage: daily_used is the number of requests the account has made today, and daily_limit is the number of requests the account can make in a day.
sequence	The number of sequential requests the client has made.
source	The API node that processed the request. Include it when you submit a support ticket.

Example Response

// GET /

{
    "status": "200",
    "message": "OK",
    "see": "https://docs.appfigures.com/api",
    "version": "2.0",
    "user": {
        "id": 1980123,
        "name": "Marshal E.",
        "email": "bigfudge@gmail.com"
    },
    "usage": {
        "daily_used": 125,
        "daily_limit": 1000
    },
    "sequence": 28,
    "source": "100"
}