Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Skills

List all skills

🔑

Required OAuth scope: skills:read.

📖

This endpoint is paginated with a page size of 500 skills. For more information, see the Pagination guide.

Lists all skills in your platform.

get/api/v2/skills

Query parameters

eq'archived' | 'published'

Filter on values equal to the given one

ne'archived' | 'published'

Filter on values not equal to the given one

instring[]

Filter on values including the given ones

ninstring[]

Filter on values excluding the given ones

Filter on status property with LHS bracket notation.

Expected value format is a string (archived, published).

{
  "eq": "archived",
  "ne": "archived",
  "in": [
    "archived"
  ],
  "nin": [
    "archived"
  ]
}
ltstring date-time

Filter on dates lower than the given one

gtestring date-time

Filter on dates greater than or equal the given one

Filter on updatedAt property with LHS bracket notation.

Expected value format is a date (YYYY-MM-DDThh:mm:ss.sssZ). The milliseconds are always set to 0.

{
  "lt": "2020-01-01T10:30:26.000Z",
  "gte": "2020-01-01T10:30:26.000Z"
}

Headers

360-api-version'v2.0' required

The version of the API.

Response

Returns one page of 500 skills.

_idstring required

The unique ID of the skill.

namestring required

The name of the skill.

status'archived' | 'published' required

The status of the skill.

externalIdstring

The unique external ID of the skill.

descriptionstring

The description of the skill.

libraryIdstring

The ID of the library that contains the skill.

createdAtstring date-time

The creation date of the skill, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

updatedAtstring date-time

The last update date of the skill, in the YYYY-MM-DDThh:mm:ss.sssZ format (ISO 8601 in Coordinated Universal Time (UTC)).

Example response

[
  {
    "_id": "SKI1234567890123abcDE",
    "name": "Releases and deployments",
    "parents": [
      {
        "_id": "SKI9876543213456abcDE",
        "externalId": "477e108e-60b5-4908-856e-aa123e133921"
      }
    ],
    "status": "published",
    "translations": [
      {
        "lang": "fr",
        "translatedFields": {
          "name": "Le nom traduit en français",
          "description": "Traduction en français de la description."
        }
      }
    ],
    "externalId": "5d9b7bf9-47bf-40ca-b670-2a2a80d992da",
    "description": "Did the user already release the software on the production environment?",
    "libraryId": "6b14f596-b5dd-40bf-af4c-a4270487a3c4",
    "createdAt": "2024-01-01T10:00:00.000Z",
    "updatedAt": "2024-01-02T08:00:00.000Z"
  }
]