GET /companies/{id}/competency-matrix

Summary

Get company competency matrix

URL Parameters

Name	Type	Required	Description
id	string	Yes	Company identifier

Query Parameters

• None

Request Body Fields

No request body is accepted for this endpoint.

Request Example

cURL

curl -X GET 'https://api.requidex.com/api/open/v1/companies/{id}/competency-matrix' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Accept: application/json'

JavaScript

const response = await fetch(
  "https://api.requidex.com/api/open/v1/companies/{id}/competency-matrix",
  {
    method: "GET",
    headers: {
      Authorization: "Bearer <API_KEY>",
      Accept: "application/json",
    },
  }
);

const json = await response.json();

Python

import requests

response = requests.request(
    'GET',
    'https://api.requidex.com/api/open/v1/companies/{id}/competency-matrix',
    headers={
        'Authorization': 'Bearer <API_KEY>',
        'Accept': 'application/json',
    },
    timeout=30,
)

print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/companies/{id}/competency-matrix", nil)
  req.Header.Set("Authorization", "Bearer <API_KEY>")
  req.Header.Set("Accept", "application/json")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  payload, _ := io.ReadAll(resp.Body)
  fmt.Println(string(payload))
}

Response Fields

Field	Type	Description
company	object	Company reference with id and name
entries	array	Competency matrix entries for the company

Each entry includes:

• trade, sector, requirements
• trade contains id and name
• requirements is an array of rule objects with items and grouped items, each containing qualification name only

Response Example (200)

{
  "success": true,
  "data": {
    "company": {
      "id": "67bc36db80a1616ec3f47001",
      "name": "Requidex Construction Ltd"
    },
    "entries": [
      {
        "trade": {
          "id": "67bc36db80a1616ec3f47031",
          "name": "Electrician"
        },
        "sector": {
          "id": "67bc36db80a1616ec3f47020",
          "name": "Commercial"
        },
        "requirements": [
          {
            "rule": "mandatory",
            "items": [
              {
                "name": "ECS Gold Card"
              }
            ],
            "groups": []
          }
        ]
      }
    ]
  }
}

Errors

HTTP Status	Description
400	Invalid or missing company id
401	Missing, invalid, revoked, or expired API key
403	Forbidden due to scope, IP restrictions, or company access
404	Company not found
405	Method not allowed on Open API routes
429	Rate limit exceeded
500	Unexpected internal error