---
category: [Administration & Integrations, Platform and Product Extensions, Platform and Product Extensions/Integration, Administration & Integrations/Custom Integrations & Apps, Platform and Product Extensions/Workday Extend]
nav: wcp_docs
parent_url: /wcp_docs/
title: Skill Lookup REST APIs
layout: subsection
---

## <a id="section_20"></a>Overview

The Skill Lookup REST APIs enable you to search skills by name or ID.

## <a id="section_urlBasePath"></a>URLs

```
https://api.workday.com/ml/skills-cloud/{version}/skills/lookup-by-name
```

```
https://api.workday.com/ml/skills-cloud/{version}/skills/lookup-by-id
```

For regional URL base paths, see [Reference: Workday Extend API Gateways and Authorization Base URLs](/wcp_docs/dlh1653340161856.html).

## <a id="section_21"></a>Finding Skills by Name

For a skills lookup by name, call this endpoint:

```
POST {baseURL}/skills/lookup-by-name
```

In the request body, specify the required `skill_names[]`, which contains 1 or more skill `name` objects. Example

```
{
"skill_names": [
  {"name": "a skill"},
  {"name": "another skill"}
]
}
```

This endpoint searches Workday's Skills Cloud and returns a list of skill objects whose names exactly match the specified skill names. The returned list contains the matching skill objects, sorted by the order the names are listed in the request. If you set the `canonicalize` request field to true, the returned list contains the canonical equivalent of the matched names.

To look up a skill in a locale other than the English default, specify the `input_locale` and `output_locale` fields in the request body. For valid locale code values, see [Reference: Skills Cloud Locales](/wcp_docs/GUID-b3c75508-018f-4cce-9d4d-9718cf5dfc69-enHYPHENus.html).

The maximum number of results is 50.

This sample request looks up the machine learning skill:

```
POST https://api.workday.com/ml/skills-cloud/v2/skills/lookup-by-name
```

Sample request body:

```
{
"skill_names": [
 {"name": "machine learning"}
]
}
```

Sample response:

```

{
"data": [
    {
        "skill": [
            {
                "id": "REMOTE_SKILL-1-47031",
                "name": "Machine Learning",
                "locale": "en_US",
                "category": {
                    "category_name": "Artificial Intelligence",
                    "relevance": 0.9973
                },
                "description": {
                    "text": "Machine Learning is a subset of artificial intelligence that involves the development of algorithms and statistical models that enable computers to perform tasks without explicit programming. Being knowledgeable in Machine Learning may involve understanding various types of learning algorithms, data mining, statistical pattern recognition, and the ability to apply these techniques to large datasets. A professional skilled in Machine Learning can help an organization with tasks such as predictive analytics, customer segmentation, fraud detection, and the development of recommendation systems."
                },
                "is_maintained": false,
                "annotation": "Canonical"
            }
        ],
        "original_skill_name": "machine learning"
    }
]
}
 
```

## <a id="section_9"></a>Finding a Skill by ID

To find a specific skill with a given skill ID, call this endpoint:

```
POST {baseURL}/skills/lookup-by-id
```

In the request body, specify the required `ids[]`, which contains 1 or more skill `id` objects. Example:

```
{
"ids": [
 {"id": "REMOTE_SKILL-1"},
 {"id": "REMOTE_SKILL-2"}
]
}
```

This endpoint searches Workday's Skills Cloud and returns a list containing the skill whose IDs match the specified IDs. The returned list contains the matching skill objects, sorted by the order they are listed in the request.

This sample request looks up a skill by a specific remote ID:

```
POST https://api.workday.com/ml/skills-cloud/v2/skills/lookup-by-id
```

Sample request body:

```
{
"ids": [
 {"id": "REMOTE_SKILL-1-10"}
]
}
```

Sample response:

```
{
 "data": [
     {
         "skill": [
             {
                 "id": "REMOTE_SKILL-1-10",
                 "name": "Task Identity",
                 "locale": "en_US",
                 "category": {
                     "category_name": "Teamwork",
                     "relevance": 0.3891
                 },
                 "description": {
                     "text": "Task Identity is a concept in job design that refers to the degree to which a job requires completion of a whole and identifiable piece of work, from beginning to end with a visible outcome. Being knowledgeable in Task Identity may involve understanding how to structure jobs and tasks in a way that allows employees to see the tangible results of their efforts, thereby enhancing their sense of accomplishment and motivation. A professional skilled in Task Identity can help an organization with job design, improving employee engagement and productivity, and creating a work environment where individuals can see the direct impact of their work on the organization's goals."
                 },
                 "is_maintained": false,
                 "annotation": "Canonical"
             }
         ]
     }
 ]
}
```

## <a id="section_22"></a>Limitations

-   Any text data input must use a single language. For supported languages, see [Reference: Skills Cloud Locales](/wcp_docs/GUID-b3c75508-018f-4cce-9d4d-9718cf5dfc69-enHYPHENus.html).
-   The Skill Lookup APIs don't support maintained, external, or crowdsourced skills.