Quick Docs

In this section, you will get an overview of our API endpoints, parameter descriptions, sample requests and responses

Getting a quick overview of our API endpoint parameter descriptions, sample requests, and responses during development is very easy.

By simply adding /meta to any of our v1 APIs, it returns what we call quick documentation that contains all the information you need about that endpoint. The documentation includes:

• API description
• Parameters and descriptions
• Required values for parameters
• Headers
• Sample Requests
• Samples Responses, e.t.c

How to use Quick Docs

Let's demonstrate how to use quick docs by using the /currencies endpoint.

Here is the response you will receive when you call the quick docs endpoint:

{
    "description": "Fetch all customers on your account",
    "endpoint": "GET /customers",
    "headers": {
        "Authorization": "Bearer {Secret Key}",
        "Content-Type": "application/json"
    },
    "request_spec": {
        "type": "params_query",
        "spec": {
            "from": "This is the specified date to start the list from e.g. 2018-01-01",
            "to": "The is the specified end period for the search e.g. 2018-03-20",
            "page": "This is the page number to retrieve e.g. setting 1 retrieves the first page",
            "isBlackListed": "This is the customer status, can be set to true or false etc",
            "email": "This is the email address relating to a customer",
            "phoneNumber": "This is the phone number address relating to a customer"
        }
    },
    "sample_request": "GET /customers?from=2020-03-01&to=2020-04-01&isBlackListed=false&page=1?phoneNumber=+234xxxxxx&email=example@example.com",
    "sample_response": {
        "status": "success",
        "message": "Customers fetched",
        "meta": {
            "pagination": {
                "total": 129,
                "count": 1,
                "from": 13,
                "to": 13
            }
        },
        "data": [
            {
                "id": 1198788,
                "email": "user@gmail.com",
                "phoneNumber": "0902620185",
                "fullName": "temi desola",
                "isBlackListed": false,
                "createdAt": "2020-03-31T16:41:26.000Z"
            },
            {
                "id": 1198788,
                "email": "user@gmail.com",
                "isBlackListed": true,
                "createdAt": "2020-03-31T16:41:26.000Z"
            },
            {
                "id": 1198788,
                "email": "user@gmail.com",
                "fullName": "temi desola",
                "isBlackListed": false,
                "createdAt": "2020-03-31T16:41:26.000Z"
            },
            {
                "id": 1198788,
                "email": "user@gmail.com",
                "phoneNumber": "0902620185",
                "isBlackListed": true,
                "createdAt": "2020-03-31T16:41:26.000Z"
            }
        ]
    }
}