Try a request

Loading API specification…

API keyBearer authentication

Held in memory for this tab only. Clear it or refresh to forget it.

Code examplecURLJavaScriptPython

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

Requests go directly to the production API and use your key’s scopes and rate limits. GET requests only.

Get Company Matrix

GET/companies/{id}/competency-matrix

Access

Requirement	Value
Scope	read:companies
Company-scoped keys	Supported
Agency-scoped keys	Supported within agency access

Summary

Returns the competency requirements configured for a company. Supply projectId to resolve the effective requirements for a specific project, including applicable inherited and project-level rules.

Path Parameters

Name	Type	Required	Description
id	string	Yes	Company identifier

Query Parameters

Name	Type	Required	Description
projectId	string	No	Project identifier. When supplied, returns the effective competency matrix for that project. Additive project requirements are combined with the project's sector or company matrix; replacement project requirements are returned on their own.

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'

To retrieve the effective matrix for a project, pass projectId:

curl -X GET 'https://api.requidex.com/api/open/v1/companies/{id}/competency-matrix?projectId={projectId}' \
  -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 Show child attributes id string or null — Entity id name string — Entity name
project	object	Project reference with id and name. Returned when projectId is supplied. Show child attributes id string or null — Entity id name string — Entity name
entries	array	Competency matrix entries for the company, or effective project entries when projectId is supplied Show child attributes trade object or null Show child attributes id string or null — Trade id name string — Trade name project object or null Show child attributes id string or null — Entity id name string — Entity name sector object or null Show child attributes id string or null — Entity id name string — Entity name source string — Scope that supplied this matrix entry. For projectId requests, project means a project override, sector means the project's sector fallback, and company means the company base fallback. requirements array of objects Show child attributes rule string — Requirement rule items array of objects Show child attributes name string — Qualification name groups array of objects Show child attributes items array of objects Show child attributes name string — Qualification name

Each entry includes:

• trade, project, sector, source, requirements
• trade contains id and name
• project is populated when the entry is a project override, otherwise null
• source is project, sector, or company to show which scope supplied the entry
• 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"
    },
    "project": {
      "id": "67bc36db80a1616ec3f47055",
      "name": "Project Alpha"
    },
    "entries": [
      {
        "trade": {
          "id": "67bc36db80a1616ec3f47031",
          "name": "Electrician"
        },
        "project": {
          "id": "67bc36db80a1616ec3f47055",
          "name": "Project Alpha"
        },
        "sector": null,
        "source": "project",
        "requirements": [
          {
            "rule": "mandatory",
            "items": [
              {
                "name": "ECS Gold Card"
              }
            ],
            "groups": []
          }
        ]
      }
    ]
  }
}

MCP Tool

The MCP server exposes this operation as open_api_get_company_competency_matrix with the inputs id and projectId.

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