Getting Started
This section provides an introduction to the APIs available for interaction with the Auth Server.
You can access the Auth Server's API base endpoints at https://auth.peoplenpartners.com/api/.
API criteria
The API operates on the basis that filtering, sorting, inclusion, and search parameters are typically provided through the query parameters of your API request. These parameters are then utilized to process and apply filters accordingly. The following statements outline the specific requirements for making requests to the API.
It's important to understand these APIs criteria for a better API implementation and coding standards.
For more usage information please see the official documentation of the Laravel API toolkit package.
Available Filtering Operations and Keys
| Operations | Key | Description | Example |
|---|---|---|---|
| Searching | search | Filters results by searching for a keyword across columns. | GET /users?search=eric |
| Filtering | filters | Sorts results based on the specified field. The parameter includes an optional - for descending order. | GET /users?status=Active&id=1 |
| Sorting | sorts | Applies custom filters based on defined filter attributes. | GET /users?sorts=created_at GET /users?sorts=-created_at |
| Inclusion | includes | Eager loads specified relationships. | GET /users?includes=model,otherModel |
Sample request body
{
"search": "eric",
"filters": {
"status": "Active",
"id": 1
},
"sorts": "-created_at",
"includes" : ["roles", "clients"]
}