Get Users

This endpoint allows you gets all the registered Users

Must have the authorization to use this API

Reponse would return all users

GET https://example.com/wp-json/rimplenet/v1

200: OK Response Ok

{
    "status_code": 200,
    "status": true,
    "message": "User retrieved successfully",
    "data": {
        "others": {
            "totalPages": 9,
            "currentPage": 1
        },
        "users": [
            
            {
                "id": 1,
                "username": "Jane",
                "user_email": "[e-mail]",
                "user_created_at": "2022-05-15 00:42:33",
                "display_name": "JaneD",
                "first_name": "",
                "last_name": "",
                "roles": [
                    "administrator"
                ],
                "account_no": "00000",
                "bank_name": null,
                "bvn": "Test",
                "example_account_status": null
            },
            
           
            {
                "id": 2,
                "username": "john",
                "user_email": "[e-mail]",
                "user_created_at": "2022-07-24 16:43:54",
                "display_name": "JohnD",
                "first_name": "John",
                "last_name": "Doe",
                "roles": [
                    "subscriber"
                ],
                "account_no": null,
                "bank_name": null,
                "bvn": null,
                "example_account_status": null
            }
        ]
    },
    "error": []
}

To view request params, click on the arrow (>) at the right hand side of the endpoint url to expand or collapse

Sample Response

200 OK

{
    "status_code": 200,
    "status": true,
    "message": "User retrieved successfully",
    "data": {
        "others": {
            "totalPages": 9,
            "currentPage": 1
        },
        "users": [
            
            {
                "id": 1,
                "username": "Jane",
                "user_email": "[e-mail]",
                "user_created_at": "2022-05-15 00:42:33",
                "display_name": "JaneD",
                "first_name": "",
                "last_name": "",
                "roles": [
                    "administrator"
                ],
                "account_no": "00000",
                "bank_name": null,
                "bvn": "Test",
                "example_account_status": null
            },
            
           
            {
                "id": 2,
                "username": "john",
                "user_email": "[e-mail]",
                "user_created_at": "2022-07-24 16:43:54",
                "display_name": "JohnD",
                "first_name": "John",
                "last_name": "Doe",
                "roles": [
                    "subscriber"
                ],
                "account_no": null,
                "bank_name": null,
                "bvn": null,
                "example_account_status": null
            }
        ]
    },
    "error": []
}

Get single user

This endpoint fetches a single user.

Must have authorization to use this API

GET

To view request params, click on the arrow (>) at the right hand side of the endpoint url to expand or collapse

200 OK

{
    "status_code": 200,
    "status": true,
    "message": "User retrieved successfully",
    "data": {
        "id": 163,
        "username": "JaneDoe",
        "user_email": "[e-mail]",
        "user_created_at": "2022-11-12 09:00:24",
        "display_name": "JaneDoe",
        "first_name": "jane",
        "last_name": "Doe",
        "roles": [
            "subscriber"
        ],
        "account_no": null,
        "bank_name": null,
        "bvn": null,
        "rimplenet_account_status": null
    },
    "error": []
}{
    "status_code": 200,
    "status": true,
    "message": "User retrieved successfully",
    "data": {
        "id": 163,
        "username": "JaneDoe",
        "user_email": "[e-mail]",
        "user_created_at": "2022-11-12 09:00:24",
        "display_name": "JaneDoe",
        "first_name": "jane",
        "last_name": "Doe",
        "roles": [
            "subscriber"
        ],
        "account_no": null,
        "bank_name": null,
        "bvn": null,
        "rimplenet_account_status": null
    },
    "error": []
}{
    "status_code": 200,
    "status": true,
    "message": "User retrieved successfully",
    "data": {
        "id": 163,
        "username": "JaneDoe",
        "user_email": "[e-mail]",
        "user_created_at": "2022-11-12 09:00:24",
        "display_name": "JaneDoe",
        "first_name": "jane",
        "last_name": "Doe",
        "roles": [
            "subscriber"
        ],
        "account_no": null,
        "bank_name": null,
        "bvn": null,
        "rimplenet_account_status": null
    },
    "error": []
}{
    "status_code": 200,
    "status": true,
    "message": "User retrieved successfully",
    "data": {
        "id": 163,
        "username": "JaneDoe",
        "user_email": "[e-mail]",
        "user_created_at": "2022-11-12 09:00:24",
        "display_name": "JaneDoe",
        "first_name": "jane",
        "last_name": "Doe",
        "roles": [
            "subscriber"
        ],
        "account_no": null,
        "bank_name": null,
        "bvn": null,
        "rimplenet_account_status": null
    },
    "error": []
}

404 NOT FOUND

{
    "status_code": 404,
    "status": "Failed",
    "message": "User not found",
    "data": [],
    "error": []
}

403 FORBIDDEN

{
    "status_code": 403,
    "status": "failed",
    "message": "Permission denied",
    "data": [],
    "error": {
        "unauthorize": "caller_id is not authorized"
    }
}