Lire un employé par ID

GET

/api/payroll/employees/by-id/{id}

Retourne la fiche complète d'un employé à partir de son identifiant interne : coordonnées, mode de paiement, état, nombre de fonctions, champs définissables et dossier fiscal. Sans la portée payroll:sensitive, le NAS et les numéros bancaires sont masqués, et le dossier fiscal, les pensions alimentaires et les montants du bloc sensitive valent null. Une fiche supprimée renvoie 404 employee_not_found ; seul le listing avec include_deleted=true peut retourner une fiche marquée supprimée (status.is_deleted), et Acomba retire en général les fiches supprimées de ses index. Disponible aussi par numéro d'employé via /{code} ; le détail des fonctions se lit via /by-id/{id}/functions.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Responses

🟢200

application/json

Successful Response

Bodyapplication/json

🟠400

🟠401

🟠404

🟠409

🟠422

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https://relay.exostack.cloud//api/payroll/employees/by-id/' \
--header 'x-api-key: <api-key>'

Response Example

{
    "_links": {
        "functions": "/api/payroll/employees/by-id/193/functions",
        "self": "/api/payroll/employees/by-id/193"
    },
    "address": {
        "city": "Laval",
        "country_code": "CA",
        "line1": "123, rue Principale",
        "postal_code": "H7N 1A1"
    },
    "arrival_date": "2021-03-01T00:00:00-05:00",
    "banking": {
        "account_number": "***4567",
        "branch_number": "*0800",
        "institution_number": "***"
    },
    "birth_date": "1988-04-15T00:00:00-04:00",
    "code": "351",
    "emails": [
        {
            "address": "marie.tremblay@exemple.ca",
            "index": 1
        }
    ],
    "first_name": "Marie",
    "functions": {
        "active_count": 1,
        "total_count": 1
    },
    "gender": 2,
    "hr_hours_per_day": 8,
    "id": 193,
    "language": 12,
    "last_name": "Tremblay",
    "marital_status": 3,
    "metadata": {
        "hashing": "TRM88A0193",
        "sdk_index_used": 0,
        "sdk_interface": "Employee",
        "unique_id": 214,
        "updated_at": "2026-09-30T10:15:42-04:00",
        "updated_by_user_id": 7
    },
    "payment_mode": 2,
    "phones": [
        {
            "description": "Cellulaire",
            "index": 1,
            "number": "4505550123"
        }
    ],
    "print_stub_if_direct_deposit": false,
    "sensitive": {},
    "sin": "***-***-4286",
    "status": {
        "is_absent": false,
        "is_active": true,
        "is_archived": false,
        "is_deleted": false,
        "is_used": true,
        "show_comment_in_transactions": false
    },
    "sync": {
        "cursor": {
            "card_pos": 193,
            "modified_at": "2026-09-30T10:15:42-04:00"
        },
        "extracted_at": "2026-10-07T09:30:00-04:00",
        "organisation_id": "constructions_exemple"
    },
    "user_fields": [
        {
            "format": "days",
            "index": 1,
            "label": "Jours de congé par an",
            "scope": "employee",
            "value": 10
        }
    ],
    "vacation_date": "2021-03-01T00:00:00-05:00"
}

Modified at 2026-10-09 19:59:12

Rechercher des employés par nom de famille

Modifier un employé par ID