Skip to content

API overview

Itefy provides a unified REST API so you can integrate your equipment data with other systems — sync items, automate check-outs, react to issues, build dashboards, and more.

Base URL & versioning

Base URLhttps://api.itefy.com
Version prefix/v1/ (e.g. https://api.itefy.com/v1/items)
FormatJSON requests and responses (UTF-8)

The API is versioned in the path so we can evolve it without breaking your integration.

Response envelope

Successful responses wrap the payload in a data key, with optional meta (e.g. pagination):

json
{
  "data": [ { "id": 1, "name": "Cordless drill" } ],
  "meta": { "page": 1, "per_page": 50, "total": 128 }
}

Errors use a stable, machine-readable envelope:

json
{
  "error": {
    "code": "not_found",
    "message": "Item not found.",
    "status": 404,
    "request_id": "…",
    "fields": {}
  }
}

Always branch on the error.code, not the human-readable message.

Authentication

External integrations authenticate with an API key issued from your account:

Authorization: Bearer itf_live_<id>_<secret>

See Authentication & API credentials for how to create one. External API access is available on Business and Enterprise plans.

Next steps