About this endpoint
What it does
Retrieves a paginated list of skills from the skills database, optionally filtered by name and controlled with query parameters. The response returns skill records in data along with pagination information in links and meta.
Query Parameter(s)
| Attribute | Type | Mandatory | Description |
|---|---|---|---|
| name | String | No | Filters skills by name. |
| per_page | String | No | Controls the number of items returned per page. |
| include_related | String | No | Controls whether related skills are included in each skill record. |
Response
Returns a JSON object with required data, links, and meta fields. data is an array of skill objects, links is an object with pagination URLs, and meta is an object with pagination details.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| data | Object Array | Yes | Array of skill objects. Each item includes id, name, slug, and related_skills. |
| data[].id | String | Yes | Skill identifier. |
| data[].name | String | Yes | Skill name. |
| data[].slug | String | Yes | Skill slug. |
| data[].related_skills | Object Array | Yes | Array of related skill objects. Each item includes id, name, slug, and weight. |
| data[].related_skills[].id | String | Yes | Related skill identifier. |
| data[].related_skills[].name | String | Yes | Related skill name. |
| data[].related_skills[].slug | String | Yes | Related skill slug. |
| data[].related_skills[].weight | Integer | Yes | Related skill weight. |
| meta | Object | Yes | Pagination metadata object containing current_page, from, last_page, links, path, per_page, to, and total. |
| meta.current_page | Integer | Yes | Current page number. |
| meta.from | Integer | Yes | Starting item number for the current page. |
| meta.last_page | Integer | Yes | Last available page number. |
| meta.links | Object Array | Yes | Array of pagination link objects. Each item includes url, label, and active. |
| meta.links[].url | String | Yes | Pagination link URL. Can be null. |
| meta.links[].label | String | Yes | Pagination link label. |
| meta.links[].active | Boolean | Yes | Whether the link is active. |
| meta.path | String | Yes | Base path for the paginated resource. |
| meta.per_page | Integer | Yes | Number of items per page. |
| meta.to | Integer | Yes | Ending item number for the current page. |
| meta.total | Integer | Yes | Total number of items. |
| links | Object | Yes | Pagination navigation object containing first, last, prev, and next. |
| links.first | String | Yes | URL for the first page. |
| links.last | String | Yes | URL for the last page. |
| links.prev | String | Yes | URL for the previous page. Can be null. |
| links.next | String | Yes | URL for the next page. |