Find an employee by external ID

Look up an employee by their external_id (sent in the JSON body), the integration key that maps them to a record in a third-party system (ERP/CRM/HR).

Distinct from the fiscal tax_id.
Returns the matching employee or 404 if no employee uses that external_id within your company.

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Formatdate

X-Active-Profile?string

Operate on behalf of a child company (gestoría master key): pass its public id (UUID v7) and the request runs against that child's data without changing the key's scope, tier or environment (omit to use the key's own company). Invalid UUID → 400 parameter_invalid_uuid; unknown or non-owned id → 404 profile_not_found. See the Acting on behalf guide.

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

external_id*string

Lengthlength <= 100

Response Body

`application/json`

Request example

const apiKey = process.env.FACTUAREA_API_KEY;if (!apiKey) throw new Error("Set FACTUAREA_API_KEY");const response = await fetch("https://api.factuarea.com/v1/employees/find-by-external-id", {  method: "POST",  headers: { Authorization: `Bearer ${apiKey}`, ...{"Accept":"application/json","Content-Type":"application/json"} },  body: JSON.stringify({  "external_id": "EMP-1042"}),});if (!response.ok) throw new Error(await response.text());if (response.status !== 204) console.log(await response.json());

Response example

{
  "data": {
    "id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e01",
    "object": "employee",
    "first_name": "Lucía",
    "last_name": "Fernández Ruiz",
    "email": "lucia.fernandez@empresa.com",
    "tax_id": "12345678Z",
    "job_title": "Desarrolladora backend",
    "employment_type": "full_time",
    "contract_hours": 40,
    "hire_date": "2024-09-02",
    "termination_date": null,
    "ccaa": "MD",
    "status": "active",
    "external_id": "EMP-1042",
    "metadata": {
      "erp_code": "IVA-GEN",
      "ledger_account": "477000"
    },
    "user_id": "01933a1f-8c21-7b3d-9e4f-1a2b3c4d5e02",
    "created_at": "2024-09-02T08:00:00Z",
    "updated_at": "2026-05-04T09:03:01Z"
  }
}

{
  "error": {
    "type": "authentication_error",
    "code": "missing_api_key",
    "message": "Falta header Authorization o X-API-Key.",
    "doc_url": "https://docs.factuarea.com/guides/errors#missing_api_key",
    "request_id": "req_3f6d27c4c52654bb9d868d2cdc"
  }
}

{
  "error": {
    "type": "authorization_error",
    "code": "insufficient_scope",
    "message": "Esta operación requiere el scope 'employees:read'. Tu API key solo tiene los scopes: ninguno.",
    "doc_url": "https://docs.factuarea.com/guides/errors#insufficient_scope",
    "request_id": "req_e417581be49f6969b7e6abab7c"
  }
}

{
  "error": {
    "type": "conflict_error",
    "code": "resource_conflict",
    "message": "La operación chocó con el estado actual del recurso y no aplica ningún código de conflicto más específico.",
    "doc_url": "https://docs.factuarea.com/guides/errors#resource_conflict",
    "request_id": "req_ad8dc9067871d9ecdbfb7c931e"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_param_value",
    "message": "El campo external_id es obligatorio.",
    "param": "external_id",
    "errors": [
      {
        "param": "external_id",
        "code": "parameter_missing",
        "message": "El campo external_id es obligatorio."
      }
    ],
    "doc_url": "https://docs.factuarea.com/guides/errors#invalid_param_value",
    "request_id": "req_d2e590ed3d5cf629fc22b88fd5"
  }
}

{
  "error": {
    "type": "rate_limit_error",
    "code": "rate_limit_exceeded",
    "message": "Has excedido el límite de requests permitido. Reintenta más tarde.",
    "doc_url": "https://docs.factuarea.com/guides/errors#rate_limit_exceeded",
    "request_id": "req_0aa68a5ab86dcca11097ae52e1"
  }
}

{
  "error": {
    "type": "api_error",
    "code": "internal_error",
    "message": "Algo se rompió en nuestro lado al procesar la petición. La condición no la provoca tu payload.",
    "doc_url": "https://docs.factuarea.com/guides/errors#internal_error",
    "request_id": "req_227934c25a7d84d6cd11eb157e"
  }
}

Find an employee by external ID

Authorization

Headers

Request Body

Response Body

200application/json

401application/json

403application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`