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.
Request
- Base URL: https://api.factuarea.com/v1
- URL: https://api.factuarea.com/v1/companies/{company}/employees/find-by-external-id
- Auth: one of:
- HTTP bearer
- API key in header X-API-Key
Path parameters
Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).
Headers
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.
Request body
Response
Example response
{
"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",
"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"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.