apyhub
Back
▣ DEVELOPER TOOLS · HR

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.

GET
Skills Database
https://api.eu.apyhub.com/sharpapi/skills-database

QUICKSTART

GUIDE

Quickstart

Search the skills database by name and include related skills in the results.

curl -X GET "https://api.eu.apyhub.com/sharpapi/skills-database?name=PHP&include_related=true" \
  -H "apy-token: $APY_TOKEN"

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
  }
}
TRY ITLIVE · 1000 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

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)

AttributeTypeDescription
nameStringFilters results by skill name.
per_pageStringControls the number of items returned per page.
include_relatedStringControls 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.

ParameterTypeDescription
dataObject ArrayArray of skill objects. Each item contains id, name, slug, and related_skills.
data[].idStringSkill identifier.
data[].nameStringSkill name.
data[].slugStringSkill slug.
data[].related_skillsObject ArrayArray of related skill objects. Each item contains id, name, slug, and weight.
data[].related_skills[].idStringRelated skill identifier.
data[].related_skills[].nameStringRelated skill name.
data[].related_skills[].slugStringRelated skill slug.
data[].related_skills[].weightIntegerRelated skill weight.
linksObjectPagination links object containing first, last, prev, and next.
links.firstStringURL for the first page.
links.lastStringURL for the last page.
links.prevStringURL for the previous page, or null when there is no previous page.
links.nextStringURL for the next page, or null when there is no next page.
metaObjectPagination metadata object containing current_page, from, last_page, links, path, per_page, to, and total.
meta.current_pageIntegerCurrent page number.
meta.fromIntegerFirst item index on the current page.
meta.last_pageIntegerLast page number.
meta.linksObject ArrayArray of pagination link objects. Each item contains url, label, and active.
meta.links[].urlStringLink URL; may be null.
meta.links[].labelStringLink label.
meta.links[].activeBooleanIndicates whether the link is active.
meta.pathStringBase path for the paginated resource.
meta.per_pageIntegerNumber of items per page.
meta.toIntegerLast item index on the current page.
meta.totalIntegerTotal number of items across all pages.
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.