Get Employee

Retrieve full details for a single employee by their ID.

GET /employees/{id}

cURL

curl --request GET \
  --url "https://v1-api.ticket-plus.app/employees/42" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"

200

{
  "data": {
    "id": 42,
    "firstName": "Anna",
    "lastName": "Müller",
    "email": "[e-mail]",
    "dateOfBirth": "1990-04-15",
    "profileImage": null,
    "resource": "employee",
    "subscription": {
      "status": "active",
      "startAt": "2024-01-01",
      "nextTicketAt": "2024-06-01",
      "pausedAt": null,
      "cancelledAt": null,
      "reactivatedAt": null
    },
    "plan": {
      "type": "split-pay-plan",
      "contractSigningStatus": "accepted",
      "employeeContributionAmount": {
        "label": "€29.00",
        "value": 29.00
      }
    },
    "ticket": {
      "ticketId": "tkt_9Xk2mPqL",
      "ticketMonth": "2024-05",
      "validFrom": "2024-05-01",
      "validUntil": "2024-05-31",
      "links": {
        "apple": "https://wallet.example.com/apple/tkt_9Xk2mPqL",
        "google": "https://wallet.example.com/google/tkt_9Xk2mPqL"
      }
    },
    "hrIntergartionLinks": [
      {
        "type": "hr-integration",
        "hrId": "emp_HR_001",
        "hrIntegrationId": 7,
        "lastSyncId": "sync_abc123",
        "lastSynced": "2024-05-10T08:00:00Z"
      }
    ],
    "_links": {
      "self": { "href": "https://v1-api.ticket-plus.app/employees/42", "type": "application/json" },
      "employeeDocuments": { "href": "https://v1-api.ticket-plus.app/employees/42/documents", "type": "application/json" }
    }
  }
}

Returns the complete record for one employee — personal details, subscription status, plan type, current transit ticket, and HR integration links. Use List Employees if you need to search or filter across all employees.

cURL

curl --request GET \
  --url "https://v1-api.ticket-plus.app/employees/42" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"

200

{
  "data": {
    "id": 42,
    "firstName": "Anna",
    "lastName": "Müller",
    "email": "[e-mail]",
    "dateOfBirth": "1990-04-15",
    "profileImage": null,
    "resource": "employee",
    "subscription": {
      "status": "active",
      "startAt": "2024-01-01",
      "nextTicketAt": "2024-06-01",
      "pausedAt": null,
      "cancelledAt": null,
      "reactivatedAt": null
    },
    "plan": {
      "type": "split-pay-plan",
      "contractSigningStatus": "accepted",
      "employeeContributionAmount": {
        "label": "€29.00",
        "value": 29.00
      }
    },
    "ticket": {
      "ticketId": "tkt_9Xk2mPqL",
      "ticketMonth": "2024-05",
      "validFrom": "2024-05-01",
      "validUntil": "2024-05-31",
      "links": {
        "apple": "https://wallet.example.com/apple/tkt_9Xk2mPqL",
        "google": "https://wallet.example.com/google/tkt_9Xk2mPqL"
      }
    },
    "hrIntergartionLinks": [
      {
        "type": "hr-integration",
        "hrId": "emp_HR_001",
        "hrIntegrationId": 7,
        "lastSyncId": "sync_abc123",
        "lastSynced": "2024-05-10T08:00:00Z"
      }
    ],
    "_links": {
      "self": { "href": "https://v1-api.ticket-plus.app/employees/42", "type": "application/json" },
      "employeeDocuments": { "href": "https://v1-api.ticket-plus.app/employees/42/documents", "type": "application/json" }
    }
  }
}

Path Parameters

id · integer · required

The unique numeric ID of the employee to retrieve.

Response

data · object · required

Show properties

id · integer · required

Unique employee identifier.

firstName · string · required

Employee’s first name.

lastName · string · required

Employee’s last name.

email · string · required

Employee’s email address.

dateOfBirth · string | null

Date of birth in ISO 8601 format. null if not set.

profileImage · string | null

URL to the employee’s profile photo. null if not set.

resource · string · required

Resource type label. Always "employee".

subscription · object · required

Current subscription details.

Show properties

status · string · required

Current state. Allowed values: no-subscription, scheduled, active, scheduled-pause, paused, scheduled-cancellation, cancelled.

startAt · string | null

Date the subscription started. null if not yet started.

nextTicketAt · string | null

Date the next transit ticket will be issued. null if not applicable.

pausedAt · string | null

Date the subscription was paused. null if never paused.

cancelledAt · string | null

Date the subscription was cancelled. null if not cancelled.

reactivatedAt · string | null

Date the subscription was reactivated. null if never reactivated.

plan · object · required

The employee’s plan details.

Show properties

type · string · required

Plan type. Allowed values: fully-subsidized-plan, deferred-plan, split-pay-plan.

contractSigningStatus · string | null

Contract state. Allowed values: pending, accepted, rejected. null if no contract applies.

employeeContributionAmount · object | null

Employee’s contribution amount. Only present for split-pay-plan. null for other plans.

Show properties

label · string

Formatted display string, e.g. "€29.00".

value · number

Raw numeric value of the contribution.

ticket · object | null

The employee’s current active transit ticket. null if no ticket has been issued yet.

Show properties

ticketId · string · required

Unique ticket identifier.

ticketMonth · string · required

Month the ticket is valid for, e.g. "2024-05".

validFrom · string · required

Ticket validity start date.

validUntil · string · required

Ticket validity end date.

links · object · required

Digital wallet pass links.

Show properties

apple · string · required

Apple Wallet pass URL.

google · string · required

Google Pay pass URL.

hrIntergartionLinks · object[] · required

HR system associations for this employee.

Show hr link object

type · string · required

Link type. Allowed values: custom (manually linked), hr-integration (synced via integration).

hrId · string · required

The employee’s ID in the external HR system.

hrIntegrationId · number | null

ID of the HR integration. null for custom links.

lastSyncId · string | null

ID of the last sync that updated this link. null if never synced.

lastSynced · string | null

Timestamp of the last sync. null if never synced.

_links · object · required

HAL hypermedia links.

Show properties

self · object · required

Link to this employee resource.

Show properties

href · string · required

URL of this employee.

type · string · required

Media type.

employeeDocuments · object · required

Link to this employee’s documents.

Show properties

href · string · required

URL to list this employee’s documents.

type · string · required

Media type.

Authorizations

Authorization · string · header · required

HTTP Basic Auth using your API key credentials. Use the username and password issued from the Developer Portal. Encode them as Base64(username:password) and pass in the Authorization: Basic <token> header.

Path Parameters

id · integer · required

The unique numeric ID of the employee to retrieve.

Response

200 - application/json

The requested employee's full record.

data · object

Show child attributes