API Docs

API: Get All Designations

Request

Retrieve all designations with a GET request:

GET /designations

Available Query Parameters:

Parameter Type Description Example
page Integer Number of page (min: 1) 1
per_page Integer Number of items per page (max: 1000) 10
search String Designation name to search Search Word

Sample Response:


{
    "status": "success",
    "message": "Designations retrieved successfully",
    "data" : [
        "current_page": 1,
        "data": [
            {
            "id": 1,
            "name": "Developer",
            "status": 1,
            "created_by": 1,
            "updated_by": 1,
            "created_at": "2020-01-01T12:00:00",
            "updated_at": "2020-01-01T12:00:00",
            }
        ],
        "first_page_url": "http://127.0.0.1:8000/api/designations?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://127.0.0.1:8000/api/designations?page=1",
        "links": [
        {
            "url": null,
            "label": "« Previous",
            "active": false
        },
        {
            "url": "http://127.0.0.1:8000/api/designations?page=1",
            "label": "1",
            "active": true
        },
        {
            "url": null,
            "label": "Next »",
            "active": false
        }
        ],
        "next_page_url": null,
        "path": "http://127.0.0.1:8000/api/designations",
        "per_page": 10,
        "prev_page_url": null,
        "to": 1,
        "total": 1
    ]

}