View file api_docs/endpoints/fetch_followers/content.phtml

File size: 2.98Kb
<div class="content__inner">
    <h2>Fetch followers of an account</h2>
    <p>
        Please use this <strong>(<?php echo cl_link("mobile_api/fetch_followers"); ?>) API for accessing endpoint of user (followers) list</strong> 
    </p>
    <br>
    <h4 class="table-title">Get parameters</h4>
    <table class="table table-bordered">
        <thead>
        <tr>
            <th width="15%">Field</th>
            <th width="25%">Value</th>
            <th width="45%">Remarks</th>
        </tr>
        </thead>
        <tbody>
            <tr>
                <td>offset</td>
                <td>Last user offset ID</td>
                <td>
                    This is only needed when loading users of the pagination system.
                </td>
            </tr>
            <tr>
                <td>session_id</td>
                <td>​Access token ID (Optional)</td>
                <td>
                    E.g. de25cc16eb00960f076...
                </td>
            </tr>
            <tr>
                <td>user_id</td>
                <td>​User int ID</td>
                <td>
                    E.g. 12
                </td>
            </tr>
            <tr>
                <td>page_size</td>
                <td>​Total users limit for each request</td>
                <td>
                    Recommended: 20
                </td>
            </tr>
        </tbody>
    </table>
    <h4 class="table-title">Success response</h4>
    <div class="code-holder">
        <div class="code-holder-inner">
    <pre><code class="json">{
        "code": 200,
        "message": "Followers fetched successfully",
        "data": [
            {
                "offset_id": 35,
                "id": 18,
                "about": "",
                "followers": 0,
                "posts": 1,
                "avatar": "http://colibri.loc/upload/avatars/xxxx/xxxx/rddNMSoS6S7cEgHO49Ch_20_456548..8_thumbnail_512x512.jpg",
                "last_active": "21 Jun, 21 01:06 PM",
                "username": "@john_smith",
                "fname": "John",
                "lname": "Smith",
                "email": "john_smith@gmail.com",
                "verified": "0",
                "follow_privacy": "approved",
                "name": "John Smith",
                "url": "http://colibri.loc/@john_smith",
                "is_following": false,
                "follow_requested": false,
                "is_user": false
            },
            ...
        ]
    }
    </code></pre>
        </div>
    </div>
    <h4 class="table-title">Error responses</h4>
    <div class="code-holder">
        <div class="code-holder-inner">
    <pre><code class="json">{
        "message": "No data found",
        "code": 204,
        "data": []
    }

    {
        "code": 404,
        "message": "User with this ID does not exist",
        "data": []
    }

    {
        "code": 400,
        "message": "This profile data is not available for viewing",
        "data": []
    }
    </code></pre>
        </div>
    </div>
</div>