Skills Directory — browse skills and related matches

Skills Database API

What it does

Skills Directory lets you look up skills by name and page through a skills list. Send a name, per_page, or include_related query, and get back structured skill records with their related skills, along with pagination metadata and navigation links.

Each item in data includes an id, name, slug, and related_skills array. Related skills are returned with their own id, name, slug, and weight, which makes it easy to rank or group adjacent skills in your product. The response also includes meta fields such as current_page, from, last_page, per_page, to, and total, plus links for first, last, prev, and next pages.

Use Skills Directory when you need a canonical skills list for search, filtering, onboarding flows, job taxonomy, or recommendation systems. For example, you can match a user-entered skill name to the catalog, then surface related skills to suggest next steps or similar capabilities.

Because the response is already normalized, you can feed it directly into autocomplete, internal tooling, or analytics without additional reshaping.

What you'll get back

Returns a JSON object with 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.

{
  "data": [
    {
      "id": "df0d4541-2a03-49ba-aefc-6cb46f6cc26c",
      "name": "PHP",
      "slug": "php",
      "related_skills": [
        {
          "id": "064887a2-1dc1-4523-9dc1-a7fa68d85f07",
          "name": "API Development",
          "slug": "api-development",
          "weight": 6
        }
      ]
    }
  ],
  "links": {
    "first": "https://apyhub.com/api/v1/utilities/skills_list?name=PHP&include_related=true&page=1",
    "last": "https://apyhub.com/api/v1/utilities/skills_list?name=PHP&include_related=true&page=2",
    "prev": null,
    "next": "https://apyhub.com/api/v1/utilities/skills_list?name=PHP&include_related=true&page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 2,
    "links": [],
    "path": "https://apyhub.com/api/v1/utilities/skills_list",
    "per_page": 15,
    "to": 15,
    "total": 25
  }
}

About this endpoint

What it does

Retrieves a paginated skills database result set, optionally filtered by skill name and optionally including related skills. The response returns a JSON object with data, links, and meta.

Query Parameter(s)

Attribute	Type	Mandatory	Description
name	String	No	Filters results by skill 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 three top-level fields: data is an array of skill objects, links is an object with pagination URLs, and meta is an object with pagination metadata.

Parameter	Type	Mandatory	Description
data	Object Array	Yes	Array of skill objects. Each item contains `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 contains `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.
links	Object	Yes	Pagination links 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, or null when there is no previous page.
links.next	String	Yes	URL for the next page, or null when there is no next page.
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	First item index on the current page.
meta.last_page	Integer	Yes	Last page number.
meta.links	Object Array	Yes	Array of pagination link objects. Each item contains `url`, `label`, and `active`.
meta.links[].url	String	Yes	Link URL; may be null.
meta.links[].label	String	Yes	Link label.
meta.links[].active	Boolean	Yes	Indicates 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	Last item index on the current page.
meta.total	Integer	Yes	Total number of items across all pages.

Query parameters

Name

Type

Description

nameOPTIONAL

string

—

per_pageOPTIONAL

string

—

include_relatedOPTIONAL

string

—

Skills Database API

What it does

Quickstart

What you'll get back

About this endpoint

What it does

Query Parameter(s)

Response

Query parameters

Errors any endpoint can return