API-Referenz

Alle Aufrufe der Fleetiva API, nach Bereichen geordnet, mit Parametern, Feldern, Antworten und einer Testkonsole. Darunter die Datenformate.

Alle Aufrufe brauchen den Header Authorization: Bearer mit dem Schlüssel, jede Antwort trägt X-Request-Id. Die Regeln für alle Aufrufe – Anmeldung, Idempotenz, Grenzen und Fehler – stehen im Handbuch.

Inhalt

Anfragen

POST`/inquiries`

Anfrage anlegen · create_inquiry · Bereich: inquiries.create

Create a transport inquiry for one or more passengers (people with special needs) on behalf of the requesting person. The operator reviews it in the Fleetiva inbox; nothing is booked automatically. Requires an Idempotency-Key: the same key with the same content returns the existing inquiry, with different content it is rejected.

Parameter

Name	Ort	Pflicht	Werte	Beschreibung
`Idempotency-Key`	header	ja	1–120 Zeichen	Your own ID for this inquiry, e.g. a UUID or your booking number. Send the same key when you retry the same request: with the same content you get the existing inquiry back (200), with different content the call is rejected (422). Not only spaces.
`Fleetiva-Dry-Run`	header	nein	eins von: `true`, `false`	`true`: check the call without any effect — same authentication, scope, limits and validation, but nothing is created, no one is notified and nothing is stored; a passed check answers 204 without a body. Not checked: whether the Idempotency-Key was already used. `false` or no header: the call takes effect. Any other value is rejected (400).

Inhalt (JSON)

JSON object, at most 64 KB.

Feld	Typ	Pflicht	Werte	Beschreibung
`requester`	`Requester`	ja		The person or institution asking for transport — the operator replies to them. Email or phone is required.
`passengers`	Liste von `Passenger`	ja	1–20 Einträge	The people to be transported, one entry each.
`message`	string	nein	höchstens 4000 Zeichen darf null sein	Free text for the operator.
`consent`	`Consent`	ja		Consent your system obtained from the person before sending (required).

Antworten

Status	Beschreibung
200	Same Idempotency-Key and same content again: the existing inquiry, nothing new is created.
201	Inquiry created.
204	Dry run passed (`Fleetiva-Dry-Run: true`): everything was checked, nothing was created. No body.
400	`invalid_input`: Invalid request
401	`unauthorized`: Missing or invalid API key
403	`forbidden`: The API key lacks the scope for this operation; `access_inactive`: API access is not active for this account
413	`payload_too_large`: Request body too large
415	`unsupported_media_type`: Content-Type must be application/json
422	`idempotency_key_reused`: Idempotency-Key was already used with different content
429	`rate_limited`: Too many requests
503	`unavailable`: Service unavailable

Was die Fehlercodes bedeuten und wie Sie sie auswerten: Fehlerbehandlung.

Felder der Antwort

Feld	Typ	Pflicht	Werte	Beschreibung
`id`	string	ja	Format `uuid`	ID of the inquiry — keep it to query the status.
`duplicate`	boolean	ja		`true` if this Idempotency-Key was already used with the same content; the existing inquiry is returned.

Beispiel

HTTP/1.1 200

{
  "id": "0b7c6d1e-2f3a-4b5c-8d9e-0f1a2b3c4d5e",
  "duplicate": true
}

GET`/inquiries/{id}`

Status einer Anfrage abfragen · get_inquiry_status · Bereich: inquiries.create

Read the processing status of an inquiry this API client created (new, in_progress, accepted, rejected). Inquiries of other clients, unknown and deleted ones are all reported as not found.

Parameter

Name	Ort	Pflicht	Werte	Beschreibung
`id`	path	ja	Format `uuid`	ID returned when the inquiry was created.

Antworten

Status	Beschreibung
200	Status of the inquiry.
400	`invalid_input`: Invalid request
401	`unauthorized`: Missing or invalid API key
403	`forbidden`: The API key lacks the scope for this operation; `access_inactive`: API access is not active for this account
404	`not_found`: Not found
429	`rate_limited`: Too many requests
503	`unavailable`: Service unavailable

Was die Fehlercodes bedeuten und wie Sie sie auswerten: Fehlerbehandlung.

Felder der Antwort

Feld	Typ	Pflicht	Werte	Beschreibung
`id`	string	ja	Format `uuid`	ID of the inquiry.
`status`	string	ja	eins von: `new`, `in_progress`, `accepted`, `rejected`	`new` (not yet processed), `in_progress` (the operator is working on it), `accepted` (taken over for planning) or `rejected`.
`received_at`	string	ja		When the inquiry was received (ISO 8601 with offset).

Beispiel

HTTP/1.1 200

{
  "id": "0b7c6d1e-2f3a-4b5c-8d9e-0f1a2b3c4d5e",
  "status": "in_progress",
  "received_at": "2026-11-02T09:15:00+00:00"
}

Kunden

GET`/customers`

Kunden auflisten · list_customers · Bereich: master_data.read

List the customers of the transport service (institutions, authorities, cost bearers, private persons), ordered by last change, oldest first. Page with cursor; sync with updated_since and list_deleted_customers.

Parameter

Name	Ort	Pflicht	Werte	Beschreibung
`limit`	query	nein	1–200 darf null sein	Records per page, 1–200. Default 50.
`cursor`	query	nein	höchstens 500 Zeichen darf null sein	`next_cursor` of the previous page, unchanged. Use it with the same filters. Omit it for the first page.
`updated_since`	query	nein	Format `date-time` darf null sein	Only records changed at or after this time (ISO 8601 with offset). For syncing: use the start of your previous sync minus a few minutes — a record may come twice, store by `id`.
`status`	query	nein	eins von: `active`, `inactive`, `archived` darf null sein	Only customers with this status.
`type`	query	nein	eins von: `agency`, `carrier`, `institution`, `private`, `caretaker` darf null sein	Only customers of this type.
`include`	query	nein	darf null sein	Field groups to add: `billing` (needs the scope `accounting.read`). Comma-separated.

Antworten

Status	Beschreibung
200	One page of customers changed since the given time; more follow with `next_cursor`.
400	`invalid_input`: Invalid request
401	`unauthorized`: Missing or invalid API key
403	`forbidden`: The API key lacks the scope for this operation; `access_inactive`: API access is not active for this account
429	`rate_limited`: Too many requests
503	`unavailable`: Service unavailable

Was die Fehlercodes bedeuten und wie Sie sie auswerten: Fehlerbehandlung.

Felder der Antwort

Feld	Typ	Pflicht	Werte	Beschreibung
`data`	Liste von object	ja		Customers, ordered by `updated_at`, then `id`.
`data[].id`	string	ja		ID of the customer.
`data[].number`	string	ja	darf null sein	Customer number assigned by the operator.
`data[].name`	string	ja		Name of the customer, e.g. the institution or the person.
`data[].type`	string	ja	eins von: `agency`, `carrier`, `institution`, `private`, `caretaker` darf null sein	`agency` (public authority, e.g. youth welfare office), `carrier` (cost bearer, e.g. health insurance), `institution` (e.g. workshop, school, day care centre), `private` (private person), `caretaker` (legal guardian). `null` when not set.
`data[].status`	string	ja	eins von: `active`, `inactive`, `archived` darf null sein	`active`, `inactive` or `archived`. `null` when not set.
`data[].email`	string	ja	darf null sein	Email address.
`data[].phone`	string	ja	darf null sein	Phone number.
`data[].fax`	string	ja	darf null sein	Fax number.
`data[].website`	string	ja	darf null sein	Website.
`data[].postal_address`	object	ja	darf null sein	Postal address, e.g. for invoices.
`data[].postal_address.street`	string	ja	darf null sein	Street.
`data[].postal_address.house_number`	string	ja	darf null sein	House number.
`data[].postal_address.zip`	string	ja	darf null sein	Postal code.
`data[].postal_address.city`	string	ja	darf null sein	City.
`data[].postal_address.country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`data[].postal_address.address_line_2`	string	ja	darf null sein	Address supplement, e.g. building or floor.
`data[].postal_address.po_box`	string	ja	darf null sein	PO box, instead of a street.
`data[].postal_address.department`	string	ja	darf null sein	Department.
`data[].postal_address.attention`	string	ja	darf null sein	For the attention of a person.
`data[].postal_address.reference`	string	ja	darf null sein	Reference of the addressee, e.g. a file number.
`data[].physical_address`	object	ja	darf null sein	Physical address, if it differs from the postal address — e.g. where passengers are dropped off.
`data[].physical_address.street`	string	ja	darf null sein	Street.
`data[].physical_address.house_number`	string	ja	darf null sein	House number.
`data[].physical_address.zip`	string	ja	darf null sein	Postal code.
`data[].physical_address.city`	string	ja	darf null sein	City.
`data[].physical_address.country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`data[].physical_address.address_line_2`	string	ja	darf null sein	Address supplement, e.g. building or floor.
`data[].physical_address.po_box`	string	ja	darf null sein	PO box, instead of a street.
`data[].physical_address.department`	string	ja	darf null sein	Department.
`data[].physical_address.attention`	string	ja	darf null sein	For the attention of a person.
`data[].physical_address.reference`	string	ja	darf null sein	Reference of the addressee, e.g. a file number.
`data[].notes`	string	ja	darf null sein	Notes of the operator.
`data[].created_at`	string	ja	darf null sein	When the customer was created (ISO 8601 with offset).
`data[].updated_at`	string	ja		When the customer was last changed (ISO 8601 with offset).
`data[].billing`	object	nein		Billing data. Only with `include=billing` and the scope `accounting.read`.
`data[].billing.tax_id`	string	ja	darf null sein	Tax number.
`data[].billing.vat_id`	string	ja	darf null sein	VAT ID.
`data[].billing.buyer_reference`	string	ja	darf null sein	Buyer reference for e-invoices (Leitweg-ID in Germany).
`data[].billing.payment_method`	string	ja	darf null sein	Payment method as entered by the operator, free text.
`data[].billing.bank_account`	object	ja	darf null sein	Bank account; `null` when none is stored.
`data[].billing.bank_account.account_holder`	string	ja	darf null sein	Account holder.
`data[].billing.bank_account.bank_name`	string	ja	darf null sein	Name of the bank.
`data[].billing.bank_account.iban`	string	ja	darf null sein	IBAN.
`data[].billing.bank_account.bic`	string	ja	darf null sein	BIC.
`next_cursor`	string	ja	darf null sein	Pass it as `cursor` to get the next page. `null`: there are no more records.

Beispiel

HTTP/1.1 200

{
  "data": [
    {
      "id": "7a1f3c2e-5b4d-4e6f-9a8b-1c2d3e4f5a6b",
      "number": "K-1042",
      "name": "Tagesförderstätte Sonnenhof",
      "type": "institution",
      "status": "active",
      "email": "verwaltung@example.org",
      "phone": "+49 30 1234567",
      "fax": null,
      "website": null,
      "postal_address": {
        "street": "Lindenallee",
        "house_number": "12",
        "zip": "10115",
        "city": "Berlin",
        "country": "DE",
        "address_line_2": null,
        "po_box": null,
        "department": null,
        "attention": null,
        "reference": null
      },
      "physical_address": null,
      "notes": "Drop-off at the side entrance.",
      "created_at": "2026-09-14T08:30:00.000000+00:00",
      "updated_at": "2026-11-02T07:45:12.345678+00:00"
    }
  ],
  "next_cursor": "WyIyMDI2LTExLTAyVDA3OjQ1OjEyLjM0NTY3OCswMDowMCIsIjdhMWYzYzJlLTViNGQtNGU2Zi05YThiLTFjMmQzZTRmNWE2YiJd"
}

GET`/customers/{id}`

Einen Kunden lesen · get_customer · Bereich: master_data.read

Read one customer by ID. Unknown and deleted customers are reported as not found.

Parameter

Name	Ort	Pflicht	Werte	Beschreibung
`id`	path	ja	Format `uuid`	ID of the customer.
`include`	query	nein	darf null sein	Field groups to add: `billing` (needs the scope `accounting.read`). Comma-separated.

Antworten

Status	Beschreibung
200	The customer with the field group `billing`.
400	`invalid_input`: Invalid request
401	`unauthorized`: Missing or invalid API key
403	`forbidden`: The API key lacks the scope for this operation; `access_inactive`: API access is not active for this account
404	`not_found`: Not found
429	`rate_limited`: Too many requests
503	`unavailable`: Service unavailable

Was die Fehlercodes bedeuten und wie Sie sie auswerten: Fehlerbehandlung.

Felder der Antwort

Feld	Typ	Pflicht	Werte	Beschreibung
`id`	string	ja		ID of the customer.
`number`	string	ja	darf null sein	Customer number assigned by the operator.
`name`	string	ja		Name of the customer, e.g. the institution or the person.
`type`	string	ja	eins von: `agency`, `carrier`, `institution`, `private`, `caretaker` darf null sein	`agency` (public authority, e.g. youth welfare office), `carrier` (cost bearer, e.g. health insurance), `institution` (e.g. workshop, school, day care centre), `private` (private person), `caretaker` (legal guardian). `null` when not set.
`status`	string	ja	eins von: `active`, `inactive`, `archived` darf null sein	`active`, `inactive` or `archived`. `null` when not set.
`email`	string	ja	darf null sein	Email address.
`phone`	string	ja	darf null sein	Phone number.
`fax`	string	ja	darf null sein	Fax number.
`website`	string	ja	darf null sein	Website.
`postal_address`	object	ja	darf null sein	Postal address, e.g. for invoices.
`postal_address.street`	string	ja	darf null sein	Street.
`postal_address.house_number`	string	ja	darf null sein	House number.
`postal_address.zip`	string	ja	darf null sein	Postal code.
`postal_address.city`	string	ja	darf null sein	City.
`postal_address.country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`postal_address.address_line_2`	string	ja	darf null sein	Address supplement, e.g. building or floor.
`postal_address.po_box`	string	ja	darf null sein	PO box, instead of a street.
`postal_address.department`	string	ja	darf null sein	Department.
`postal_address.attention`	string	ja	darf null sein	For the attention of a person.
`postal_address.reference`	string	ja	darf null sein	Reference of the addressee, e.g. a file number.
`physical_address`	object	ja	darf null sein	Physical address, if it differs from the postal address — e.g. where passengers are dropped off.
`physical_address.street`	string	ja	darf null sein	Street.
`physical_address.house_number`	string	ja	darf null sein	House number.
`physical_address.zip`	string	ja	darf null sein	Postal code.
`physical_address.city`	string	ja	darf null sein	City.
`physical_address.country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`physical_address.address_line_2`	string	ja	darf null sein	Address supplement, e.g. building or floor.
`physical_address.po_box`	string	ja	darf null sein	PO box, instead of a street.
`physical_address.department`	string	ja	darf null sein	Department.
`physical_address.attention`	string	ja	darf null sein	For the attention of a person.
`physical_address.reference`	string	ja	darf null sein	Reference of the addressee, e.g. a file number.
`notes`	string	ja	darf null sein	Notes of the operator.
`created_at`	string	ja	darf null sein	When the customer was created (ISO 8601 with offset).
`updated_at`	string	ja		When the customer was last changed (ISO 8601 with offset).
`billing`	object	nein		Billing data. Only with `include=billing` and the scope `accounting.read`.
`billing.tax_id`	string	ja	darf null sein	Tax number.
`billing.vat_id`	string	ja	darf null sein	VAT ID.
`billing.buyer_reference`	string	ja	darf null sein	Buyer reference for e-invoices (Leitweg-ID in Germany).
`billing.payment_method`	string	ja	darf null sein	Payment method as entered by the operator, free text.
`billing.bank_account`	object	ja	darf null sein	Bank account; `null` when none is stored.
`billing.bank_account.account_holder`	string	ja	darf null sein	Account holder.
`billing.bank_account.bank_name`	string	ja	darf null sein	Name of the bank.
`billing.bank_account.iban`	string	ja	darf null sein	IBAN.
`billing.bank_account.bic`	string	ja	darf null sein	BIC.

Beispiel

HTTP/1.1 200

{
  "id": "7a1f3c2e-5b4d-4e6f-9a8b-1c2d3e4f5a6b",
  "number": "K-1042",
  "name": "Tagesförderstätte Sonnenhof",
  "type": "institution",
  "status": "active",
  "email": "verwaltung@example.org",
  "phone": "+49 30 1234567",
  "fax": null,
  "website": null,
  "postal_address": {
    "street": "Lindenallee",
    "house_number": "12",
    "zip": "10115",
    "city": "Berlin",
    "country": "DE",
    "address_line_2": null,
    "po_box": null,
    "department": null,
    "attention": null,
    "reference": null
  },
  "physical_address": null,
  "notes": "Drop-off at the side entrance.",
  "created_at": "2026-09-14T08:30:00.000000+00:00",
  "updated_at": "2026-11-02T07:45:12.345678+00:00",
  "billing": {
    "tax_id": null,
    "vat_id": "DE123456789",
    "buyer_reference": "11001-12345-67",
    "payment_method": "Bank transfer",
    "bank_account": {
      "account_holder": "Sonnenhof gGmbH",
      "bank_name": "Musterbank",
      "iban": "DE89370400440532013000",
      "bic": "MUSTDEFFXXX"
    }
  }
}

GET`/customers/deleted`

Gelöschte Kunden auflisten · list_deleted_customers · Bereich: master_data.read

List customers deleted since a point in time, so a synced copy can remove them. Kept for a limited time; further back the call is rejected and you need a full sync.

Parameter

Name	Ort	Pflicht	Werte	Beschreibung
`since`	query	ja	Format `date-time`	Deletions at or after this time (ISO 8601 with offset), at most 90 days back. Use the same time as `updated_since` of your sync.
`limit`	query	nein	1–200 darf null sein	Records per page, 1–200. Default 50.
`cursor`	query	nein	höchstens 500 Zeichen darf null sein	`next_cursor` of the previous page, unchanged. Use it with the same filters. Omit it for the first page.

Antworten

Status	Beschreibung
200	Customers deleted since the given time.
400	`invalid_input`: Invalid request
401	`unauthorized`: Missing or invalid API key
403	`forbidden`: The API key lacks the scope for this operation; `access_inactive`: API access is not active for this account
429	`rate_limited`: Too many requests
503	`unavailable`: Service unavailable

Was die Fehlercodes bedeuten und wie Sie sie auswerten: Fehlerbehandlung.

Felder der Antwort

Feld	Typ	Pflicht	Werte	Beschreibung
`data`	Liste von object	ja		Deleted records, oldest first.
`data[].id`	string	ja		ID of the deleted record.
`data[].deleted_at`	string	ja		When it was deleted (ISO 8601 with offset).
`next_cursor`	string	ja	darf null sein	Pass it as `cursor` to get the next page. `null`: there are no more records.

Beispiel

HTTP/1.1 200

{
  "data": [
    {
      "id": "3c9e8d7f-1a2b-4c5d-8e9f-0a1b2c3d4e5f",
      "deleted_at": "2026-11-01T16:20:05.000000+00:00"
    }
  ],
  "next_cursor": null
}

Fahrgäste

GET`/passengers`

Fahrgäste auflisten · list_passengers · Bereich: master_data.read

List the passengers of the transport service, ordered by last change, oldest first. Page with cursor; sync with updated_since and list_deleted_passengers.

Parameter

Name	Ort	Pflicht	Werte	Beschreibung
`limit`	query	nein	1–200 darf null sein	Records per page, 1–200. Default 50.
`cursor`	query	nein	höchstens 500 Zeichen darf null sein	`next_cursor` of the previous page, unchanged. Use it with the same filters. Omit it for the first page.
`updated_since`	query	nein	Format `date-time` darf null sein	Only records changed at or after this time (ISO 8601 with offset). For syncing: use the start of your previous sync minus a few minutes — a record may come twice, store by `id`.
`status`	query	nein	eins von: `active`, `inactive`, `archived` darf null sein	Only passengers with this status.
`customer_id`	query	nein	Format `uuid` darf null sein	Only passengers of this customer.
`self_payer`	query	nein	darf null sein	`true`: only self-payers; `false`: only the others (passengers of a cost bearer or without a customer).
`include`	query	nein	darf null sein	Field groups to add: `health` (needs the scope `health_data`; every delivered passenger is logged) and `billing` (needs the scope `accounting.read`). Comma-separated.

Antworten

Status	Beschreibung
200	One page of active passengers changed since the given time; more follow with `next_cursor`.
400	`invalid_input`: Invalid request
401	`unauthorized`: Missing or invalid API key
403	`forbidden`: The API key lacks the scope for this operation; `access_inactive`: API access is not active for this account
429	`rate_limited`: Too many requests
503	`unavailable`: Service unavailable

Was die Fehlercodes bedeuten und wie Sie sie auswerten: Fehlerbehandlung.

Felder der Antwort

Feld	Typ	Pflicht	Werte	Beschreibung
`data`	Liste von object	ja		Passengers, ordered by `updated_at`, then `id`.
`data[].id`	string	ja		ID of the passenger.
`data[].number`	string	ja	darf null sein	Passenger number assigned by the operator.
`data[].status`	string	ja	eins von: `active`, `inactive`, `archived` darf null sein	`active`, `inactive` or `archived`. `null` when not set.
`data[].self_payer`	boolean	ja		The passenger pays for their trips themselves: they belong to the system customer for self-payers (`customer.number` `SELBSTZAHLER`), however often they ride.
`data[].salutation`	string	ja	eins von: `mr`, `ms`, `diverse` darf null sein	`mr`, `ms` or `diverse`. `null` when not set.
`data[].first_name`	string	ja	darf null sein	First name.
`data[].last_name`	string	ja		Last name.
`data[].date_of_birth`	string	ja	darf null sein	Date of birth (`YYYY-MM-DD`).
`data[].email`	string	ja	darf null sein	Email address.
`data[].phone_numbers`	Liste von object	ja		Phone numbers with a label, e.g. mobile or mother. Empty list when none.
`data[].phone_numbers[].label`	string	ja	darf null sein	Whose number, e.g. mother.
`data[].phone_numbers[].number`	string	ja		Phone number.
`data[].home_address`	object	ja	darf null sein	Home address — where the passenger is usually picked up.
`data[].home_address.street`	string	ja	darf null sein	Street.
`data[].home_address.house_number`	string	ja	darf null sein	House number.
`data[].home_address.zip`	string	ja	darf null sein	Postal code.
`data[].home_address.city`	string	ja	darf null sein	City.
`data[].home_address.country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`data[].customer`	object	ja	darf null sein	The customer (cost bearer) the passenger belongs to. Read the customer itself to sync it.
`data[].customer.id`	string	ja		ID of the customer.
`data[].customer.name`	string	ja		Name of the customer at the time of reading.
`data[].customer.number`	string	ja	darf null sein	Customer number.
`data[].reference_codes`	Liste von object	ja		Reference codes of cost bearers, as printed on documents. Empty list when none.
`data[].reference_codes[].type`	string	ja		Kind of reference, e.g. approval number.
`data[].reference_codes[].value`	string	ja		Value.
`data[].needs`	object	ja		What the passenger needs on the trip — vehicle, seat and help. Same keys as `needs` of an inquiry.
`data[].needs.wheelchair`	boolean	ja		Travels seated in the wheelchair (needs a wheelchair space and a ramp or lift). `false` when not recorded.
`data[].needs.wheelchair_transferable`	boolean	ja		Uses a wheelchair but can move to a regular seat for the trip. `false` when not recorded.
`data[].needs.rollator`	boolean	ja		Brings a rollator. `false` when not recorded.
`data[].needs.walker`	boolean	ja		Uses a walking frame. `false` when not recorded.
`data[].needs.cane`	boolean	ja		Uses a walking stick. `false` when not recorded.
`data[].needs.ambulatory`	boolean	ja		Can walk without help. `false` when not recorded.
`data[].needs.stretcher`	boolean	ja		Travels lying on a stretcher. `false` when not recorded.
`data[].needs.oxygen`	boolean	ja		Needs oxygen during the trip (needs an oxygen-equipped vehicle). `false` when not recorded.
`data[].needs.companion`	boolean	ja		Needs an escort provided by the transport service. `false` when not recorded.
`data[].needs.boarding_assistance`	boolean	ja		Needs help getting in and out of the vehicle. `false` when not recorded.
`data[].needs.assistance`	boolean	ja		Needs support during the trip. `false` when not recorded.
`data[].needs.service_animal`	boolean	ja		Travels with an assistance animal. `false` when not recorded.
`data[].needs.bicycle`	boolean	ja		Brings a bicycle. `false` when not recorded.
`data[].seat_preference`	string	ja	eins von: `no_preference`, `front`, `rear` darf null sein	`front`, `rear` or `no_preference`. `null` when not recorded.
`data[].boarding_minutes`	number	ja	darf null sein	Minutes the passenger usually needs to board.
`data[].pickup_earliest`	string	ja	darf null sein	Usual earliest pickup time (`HH:MM`, local time of the operator).
`data[].pickup_latest`	string	ja	darf null sein	Usual latest pickup time (`HH:MM`, local time of the operator).
`data[].notes`	string	ja	darf null sein	Notes of the operator.
`data[].created_at`	string	ja	darf null sein	When the passenger was created (ISO 8601 with offset).
`data[].updated_at`	string	ja		When the passenger was last changed (ISO 8601 with offset).
`data[].health`	object	nein		Health data (Art. 9 GDPR). Only for API keys with the scope `health_data` and `include=health`. Every passenger delivered with this group is logged for the operator.
`data[].health.medical_notes`	string	ja	darf null sein	Medical notes for the trip.
`data[].health.allergies`	string	ja	darf null sein	Allergies.
`data[].health.emergency_contact`	object	ja	darf null sein	Emergency contact; `null` when none is stored.
`data[].health.emergency_contact.name`	string	ja	darf null sein	Name of the contact person.
`data[].health.emergency_contact.relationship`	string	ja	darf null sein	Relationship to the passenger, e.g. mother.
`data[].health.emergency_contact.phone`	string	ja	darf null sein	Phone number.
`data[].health.needs_notes`	string	ja	darf null sein	Free text about the needs, e.g. how to help with boarding.
`data[].health.autism`	boolean	ja		The passenger is autistic. `false` when not recorded.
`data[].health.visual_impairment`	boolean	ja		The passenger has a visual impairment. `false` when not recorded.
`data[].health.cognitive_impairment`	boolean	ja		The passenger has a cognitive impairment. `false` when not recorded.
`data[].billing`	object	nein		Billing data. Only with `include=billing` and the scope `accounting.read`.
`data[].billing.name`	string	ja	darf null sein	Name on invoices, if it differs from the passenger.
`data[].billing.address`	object	ja	darf null sein	Billing address; `null` when none is stored. If neither `name` nor `address` is set, documents are addressed to the passenger at `home_address`.
`data[].billing.address.street`	string	ja	darf null sein	Street.
`data[].billing.address.house_number`	string	ja	darf null sein	House number.
`data[].billing.address.zip`	string	ja	darf null sein	Postal code.
`data[].billing.address.city`	string	ja	darf null sein	City.
`data[].billing.address.country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`data[].billing.default_tax_rate`	number	ja	darf null sein	Default VAT rate in percent for documents of this passenger.
`next_cursor`	string	ja	darf null sein	Pass it as `cursor` to get the next page. `null`: there are no more records.

Beispiel

HTTP/1.1 200

{
  "data": [
    {
      "id": "5d2e8f1a-3b4c-4d6e-9f0a-1b2c3d4e5f6a",
      "number": "F-2087",
      "status": "active",
      "self_payer": false,
      "salutation": "mr",
      "first_name": "Jonas",
      "last_name": "Beispiel",
      "date_of_birth": "2012-04-17",
      "email": null,
      "phone_numbers": [
        {
          "label": "Home",
          "number": "+49 30 7654321"
        },
        {
          "label": "Mother",
          "number": "+49 170 1234567"
        }
      ],
      "home_address": {
        "street": "Birkenweg",
        "house_number": "7",
        "zip": "10437",
        "city": "Berlin",
        "country": "DE"
      },
      "customer": {
        "id": "7a1f3c2e-5b4d-4e6f-9a8b-1c2d3e4f5a6b",
        "name": "Tagesförderstätte Sonnenhof",
        "number": "K-1042"
      },
      "reference_codes": [
        {
          "type": "Approval number",
          "value": "EGH-2026-0815"
        }
      ],
      "needs": {
        "wheelchair": true,
        "wheelchair_transferable": false,
        "rollator": false,
        "walker": false,
        "cane": false,
        "ambulatory": false,
        "stretcher": false,
        "oxygen": false,
        "companion": false,
        "boarding_assistance": true,
        "assistance": false,
        "service_animal": false,
        "bicycle": false
      },
      "seat_preference": "front",
      "boarding_minutes": 5,
      "pickup_earliest": "07:00",
      "pickup_latest": "07:20",
      "notes": "Ring twice.",
      "created_at": "2026-09-20T10:05:00.000000+00:00",
      "updated_at": "2026-11-02T06:58:41.123456+00:00"
    }
  ],
  "next_cursor": "WyIyMDI2LTExLTAyVDA2OjU4OjQxLjEyMzQ1NiswMDowMCIsIjVkMmU4ZjFhLTNiNGMtNGQ2ZS05ZjBhLTFiMmMzZDRlNWY2YSJd"
}

GET`/passengers/{id}`

Einen Fahrgast lesen · get_passenger · Bereich: master_data.read

Read one passenger by ID. Unknown and deleted passengers are reported as not found.

Parameter

Name	Ort	Pflicht	Werte	Beschreibung
`id`	path	ja	Format `uuid`	ID of the passenger.
`include`	query	nein	darf null sein	Field groups to add: `health` (needs the scope `health_data`; every delivered passenger is logged) and `billing` (needs the scope `accounting.read`). Comma-separated.

Antworten

Status	Beschreibung
200	The passenger with the field group `health` — this call is logged for the operator.
400	`invalid_input`: Invalid request
401	`unauthorized`: Missing or invalid API key
403	`forbidden`: The API key lacks the scope for this operation; `access_inactive`: API access is not active for this account
404	`not_found`: Not found
429	`rate_limited`: Too many requests
503	`unavailable`: Service unavailable

Was die Fehlercodes bedeuten und wie Sie sie auswerten: Fehlerbehandlung.

Felder der Antwort

Feld	Typ	Pflicht	Werte	Beschreibung
`id`	string	ja		ID of the passenger.
`number`	string	ja	darf null sein	Passenger number assigned by the operator.
`status`	string	ja	eins von: `active`, `inactive`, `archived` darf null sein	`active`, `inactive` or `archived`. `null` when not set.
`self_payer`	boolean	ja		The passenger pays for their trips themselves: they belong to the system customer for self-payers (`customer.number` `SELBSTZAHLER`), however often they ride.
`salutation`	string	ja	eins von: `mr`, `ms`, `diverse` darf null sein	`mr`, `ms` or `diverse`. `null` when not set.
`first_name`	string	ja	darf null sein	First name.
`last_name`	string	ja		Last name.
`date_of_birth`	string	ja	darf null sein	Date of birth (`YYYY-MM-DD`).
`email`	string	ja	darf null sein	Email address.
`phone_numbers`	Liste von object	ja		Phone numbers with a label, e.g. mobile or mother. Empty list when none.
`phone_numbers[].label`	string	ja	darf null sein	Whose number, e.g. mother.
`phone_numbers[].number`	string	ja		Phone number.
`home_address`	object	ja	darf null sein	Home address — where the passenger is usually picked up.
`home_address.street`	string	ja	darf null sein	Street.
`home_address.house_number`	string	ja	darf null sein	House number.
`home_address.zip`	string	ja	darf null sein	Postal code.
`home_address.city`	string	ja	darf null sein	City.
`home_address.country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`customer`	object	ja	darf null sein	The customer (cost bearer) the passenger belongs to. Read the customer itself to sync it.
`customer.id`	string	ja		ID of the customer.
`customer.name`	string	ja		Name of the customer at the time of reading.
`customer.number`	string	ja	darf null sein	Customer number.
`reference_codes`	Liste von object	ja		Reference codes of cost bearers, as printed on documents. Empty list when none.
`reference_codes[].type`	string	ja		Kind of reference, e.g. approval number.
`reference_codes[].value`	string	ja		Value.
`needs`	object	ja		What the passenger needs on the trip — vehicle, seat and help. Same keys as `needs` of an inquiry.
`needs.wheelchair`	boolean	ja		Travels seated in the wheelchair (needs a wheelchair space and a ramp or lift). `false` when not recorded.
`needs.wheelchair_transferable`	boolean	ja		Uses a wheelchair but can move to a regular seat for the trip. `false` when not recorded.
`needs.rollator`	boolean	ja		Brings a rollator. `false` when not recorded.
`needs.walker`	boolean	ja		Uses a walking frame. `false` when not recorded.
`needs.cane`	boolean	ja		Uses a walking stick. `false` when not recorded.
`needs.ambulatory`	boolean	ja		Can walk without help. `false` when not recorded.
`needs.stretcher`	boolean	ja		Travels lying on a stretcher. `false` when not recorded.
`needs.oxygen`	boolean	ja		Needs oxygen during the trip (needs an oxygen-equipped vehicle). `false` when not recorded.
`needs.companion`	boolean	ja		Needs an escort provided by the transport service. `false` when not recorded.
`needs.boarding_assistance`	boolean	ja		Needs help getting in and out of the vehicle. `false` when not recorded.
`needs.assistance`	boolean	ja		Needs support during the trip. `false` when not recorded.
`needs.service_animal`	boolean	ja		Travels with an assistance animal. `false` when not recorded.
`needs.bicycle`	boolean	ja		Brings a bicycle. `false` when not recorded.
`seat_preference`	string	ja	eins von: `no_preference`, `front`, `rear` darf null sein	`front`, `rear` or `no_preference`. `null` when not recorded.
`boarding_minutes`	number	ja	darf null sein	Minutes the passenger usually needs to board.
`pickup_earliest`	string	ja	darf null sein	Usual earliest pickup time (`HH:MM`, local time of the operator).
`pickup_latest`	string	ja	darf null sein	Usual latest pickup time (`HH:MM`, local time of the operator).
`notes`	string	ja	darf null sein	Notes of the operator.
`created_at`	string	ja	darf null sein	When the passenger was created (ISO 8601 with offset).
`updated_at`	string	ja		When the passenger was last changed (ISO 8601 with offset).
`health`	object	nein		Health data (Art. 9 GDPR). Only for API keys with the scope `health_data` and `include=health`. Every passenger delivered with this group is logged for the operator.
`health.medical_notes`	string	ja	darf null sein	Medical notes for the trip.
`health.allergies`	string	ja	darf null sein	Allergies.
`health.emergency_contact`	object	ja	darf null sein	Emergency contact; `null` when none is stored.
`health.emergency_contact.name`	string	ja	darf null sein	Name of the contact person.
`health.emergency_contact.relationship`	string	ja	darf null sein	Relationship to the passenger, e.g. mother.
`health.emergency_contact.phone`	string	ja	darf null sein	Phone number.
`health.needs_notes`	string	ja	darf null sein	Free text about the needs, e.g. how to help with boarding.
`health.autism`	boolean	ja		The passenger is autistic. `false` when not recorded.
`health.visual_impairment`	boolean	ja		The passenger has a visual impairment. `false` when not recorded.
`health.cognitive_impairment`	boolean	ja		The passenger has a cognitive impairment. `false` when not recorded.
`billing`	object	nein		Billing data. Only with `include=billing` and the scope `accounting.read`.
`billing.name`	string	ja	darf null sein	Name on invoices, if it differs from the passenger.
`billing.address`	object	ja	darf null sein	Billing address; `null` when none is stored. If neither `name` nor `address` is set, documents are addressed to the passenger at `home_address`.
`billing.address.street`	string	ja	darf null sein	Street.
`billing.address.house_number`	string	ja	darf null sein	House number.
`billing.address.zip`	string	ja	darf null sein	Postal code.
`billing.address.city`	string	ja	darf null sein	City.
`billing.address.country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`billing.default_tax_rate`	number	ja	darf null sein	Default VAT rate in percent for documents of this passenger.

Beispiel

HTTP/1.1 200

{
  "id": "5d2e8f1a-3b4c-4d6e-9f0a-1b2c3d4e5f6a",
  "number": "F-2087",
  "status": "active",
  "self_payer": false,
  "salutation": "mr",
  "first_name": "Jonas",
  "last_name": "Beispiel",
  "date_of_birth": "2012-04-17",
  "email": null,
  "phone_numbers": [
    {
      "label": "Home",
      "number": "+49 30 7654321"
    },
    {
      "label": "Mother",
      "number": "+49 170 1234567"
    }
  ],
  "home_address": {
    "street": "Birkenweg",
    "house_number": "7",
    "zip": "10437",
    "city": "Berlin",
    "country": "DE"
  },
  "customer": {
    "id": "7a1f3c2e-5b4d-4e6f-9a8b-1c2d3e4f5a6b",
    "name": "Tagesförderstätte Sonnenhof",
    "number": "K-1042"
  },
  "reference_codes": [
    {
      "type": "Approval number",
      "value": "EGH-2026-0815"
    }
  ],
  "needs": {
    "wheelchair": true,
    "wheelchair_transferable": false,
    "rollator": false,
    "walker": false,
    "cane": false,
    "ambulatory": false,
    "stretcher": false,
    "oxygen": false,
    "companion": false,
    "boarding_assistance": true,
    "assistance": false,
    "service_animal": false,
    "bicycle": false
  },
  "seat_preference": "front",
  "boarding_minutes": 5,
  "pickup_earliest": "07:00",
  "pickup_latest": "07:20",
  "notes": "Ring twice.",
  "created_at": "2026-09-20T10:05:00.000000+00:00",
  "updated_at": "2026-11-02T06:58:41.123456+00:00",
  "health": {
    "medical_notes": "Epilepsy: emergency medication in the backpack.",
    "allergies": "Peanuts",
    "emergency_contact": {
      "name": "Sabine Beispiel",
      "relationship": "Mother",
      "phone": "+49 170 1234567"
    },
    "needs_notes": "Fasten the wheelchair with four-point restraints.",
    "autism": false,
    "visual_impairment": false,
    "cognitive_impairment": true
  }
}

GET`/passengers/deleted`

Gelöschte Fahrgäste auflisten · list_deleted_passengers · Bereich: master_data.read

List passengers deleted since a point in time, so a synced copy can remove them. Kept for a limited time; further back the call is rejected and you need a full sync.

Parameter

Name	Ort	Pflicht	Werte	Beschreibung
`since`	query	ja	Format `date-time`	Deletions at or after this time (ISO 8601 with offset), at most 90 days back. Use the same time as `updated_since` of your sync.
`limit`	query	nein	1–200 darf null sein	Records per page, 1–200. Default 50.
`cursor`	query	nein	höchstens 500 Zeichen darf null sein	`next_cursor` of the previous page, unchanged. Use it with the same filters. Omit it for the first page.

Antworten

Status	Beschreibung
200	Passengers deleted since the given time.
400	`invalid_input`: Invalid request
401	`unauthorized`: Missing or invalid API key
403	`forbidden`: The API key lacks the scope for this operation; `access_inactive`: API access is not active for this account
429	`rate_limited`: Too many requests
503	`unavailable`: Service unavailable

Was die Fehlercodes bedeuten und wie Sie sie auswerten: Fehlerbehandlung.

Felder der Antwort

Feld	Typ	Pflicht	Werte	Beschreibung
`data`	Liste von object	ja		Deleted records, oldest first.
`data[].id`	string	ja		ID of the deleted record.
`data[].deleted_at`	string	ja		When it was deleted (ISO 8601 with offset).
`next_cursor`	string	ja	darf null sein	Pass it as `cursor` to get the next page. `null`: there are no more records.

Beispiel

HTTP/1.1 200

{
  "data": [
    {
      "id": "8e1f2a3b-4c5d-4e6f-8a9b-0c1d2e3f4a5b",
      "deleted_at": "2026-11-01T17:02:44.000000+00:00"
    }
  ],
  "next_cursor": null
}

Datenformate

Die Objekte, aus denen sich Anfragen, Datensätze und Antworten zusammensetzen. In der OpenAPI-Datei stehen sie unter components.schemas mit denselben Namen.

Anfragende Person `Requester`

The person or institution asking for transport — the operator replies to them. Email or phone is required.

Feld	Typ	Pflicht	Werte	Beschreibung
`role`	string	nein	eins von: `self`, `relative`, `institution`, `payer` darf null sein	Who is asking: `self` (the passenger), `relative`, `institution` (e.g. a care home or workshop) or `payer` (the cost bearer).
`first_name`	string	nein	höchstens 100 Zeichen darf null sein	First name of the requesting person.
`last_name`	string	ja	1–100 Zeichen	Last name of the requesting person, or a contact name at the institution.
`email`	string	nein	höchstens 254 Zeichen Format `email` darf null sein	Email address for replies. Email or phone is required.
`phone`	string	nein	höchstens 50 Zeichen darf null sein	Phone number for call-backs. Email or phone is required.
`organization`	string	nein	höchstens 255 Zeichen darf null sein	Name of the institution, if the request comes from one.
`postal_address`	`Address`	nein	darf null sein	Postal address of the requesting person or institution for the invoice; the operator uses it when creating a new customer. If any part is given, street and city are required.

Fahrgast (Anfrage) `Passenger`

A person to be transported; becomes one item of the inquiry.

Feld	Typ	Pflicht	Werte	Beschreibung
`first_name`	string	nein	höchstens 100 Zeichen darf null sein	First name of the passenger.
`last_name`	string	nein	höchstens 100 Zeichen darf null sein	Last name of the passenger.
`birth_year`	integer	nein	1900–2100 darf null sein	Year of birth — helps the operator to tell passengers with the same name apart.
`pickup`	`Address`	nein	darf null sein	Where the passenger is picked up. If any part is given, street and city are required.
`dropoff`	`Address`	nein	darf null sein	Where the passenger is taken, e.g. a school, workshop or day care centre. If any part is given, street and city are required.
`trip_kind`	string	nein	eins von: `single`, `recurring` darf null sein	`single` for a one-off trip, `recurring` for a regular transport (e.g. every school day).
`requested_date`	string	nein	darf null sein	Desired date as YYYY-MM-DD (a real calendar day); for a recurring transport the first day.
`requested_time_window`	string	nein	höchstens 80 Zeichen darf null sein	Desired time as free text, e.g. `07:30` or `arrival by 8:00`.
`return_trip`	boolean	nein	darf null sein	`true` if a return trip is wanted as well.
`return_time_window`	string	nein	höchstens 80 Zeichen darf null sein	Desired time of the return trip as free text. Rejected together with `return_trip: false`.
`vehicle_preference`	string	nein	eins von: `car`, `van`, `minibus`, `bus`, `special_vehicle` darf null sein	Preferred vehicle class. A wheelchair ramp is not a preference: set `needs.wheelchair` instead.
`needs`	`Needs`	nein	darf null sein	What the passenger needs during the trip. Health data (Art. 9 GDPR): send only with consent. Missing or `null` means none.
`payer_hint`	string	nein	höchstens 200 Zeichen darf null sein	Who is expected to pay, as free text (e.g. youth welfare office, health insurance). The operator checks it.

Adresse `Address`

An address. Street and city are required as soon as any part is given; house number and postal code are optional.

Feld	Typ	Pflicht	Werte	Beschreibung
`street`	string	nein	höchstens 255 Zeichen darf null sein	Street name.
`house_number`	string	nein	höchstens 20 Zeichen darf null sein	House number, with suffix if any (12a).
`zip`	string	nein	höchstens 20 Zeichen darf null sein	Postal code.
`city`	string	nein	höchstens 100 Zeichen darf null sein	Town or city.

Bedarfe `Needs`

Needs during the trip. Every flag is optional; true marks a need, missing or false means no.

Feld	Typ	Pflicht	Werte	Beschreibung
`wheelchair`	boolean	nein	darf null sein	Travels seated in the wheelchair (needs a wheelchair space and a ramp or lift).
`wheelchair_transferable`	boolean	nein	darf null sein	Uses a wheelchair but can move to a regular seat for the trip.
`rollator`	boolean	nein	darf null sein	Brings a rollator.
`stretcher`	boolean	nein	darf null sein	Travels lying on a stretcher.
`companion`	boolean	nein	darf null sein	Needs an escort provided by the transport service.
`boarding_assistance`	boolean	nein	darf null sein	Needs help getting in and out of the vehicle.
`private_companion`	boolean	nein	darf null sein	A relative or private companion rides along and takes a seat.
`other`	string	nein	höchstens 500 Zeichen darf null sein	Other needs as free text.

Einwilligung `Consent`

Consent your system obtained from the person before sending (required).

Feld	Typ	Pflicht	Werte	Beschreibung
`given`	boolean	ja	genau `true`	Must be `true`: the person agreed that the operator processes the data, including the needs (health data).
`text_version`	string	ja	1–36 Zeichen	Version of the consent text the person saw, e.g. `2026-11`. Stored with the inquiry as proof.
`given_at`	string	nein	Format `date-time` darf null sein	When consent was given (ISO 8601 with offset). Defaults to the time of receipt; must not be in the future.

Kunde `Customer`

A customer of the operator: institution, authority, cost bearer or private person.

Feld	Typ	Pflicht	Werte	Beschreibung
`id`	string	ja		ID of the customer.
`number`	string	ja	darf null sein	Customer number assigned by the operator.
`name`	string	ja		Name of the customer, e.g. the institution or the person.
`type`	string	ja	eins von: `agency`, `carrier`, `institution`, `private`, `caretaker` darf null sein	`agency` (public authority, e.g. youth welfare office), `carrier` (cost bearer, e.g. health insurance), `institution` (e.g. workshop, school, day care centre), `private` (private person), `caretaker` (legal guardian). `null` when not set.
`status`	string	ja	eins von: `active`, `inactive`, `archived` darf null sein	`active`, `inactive` or `archived`. `null` when not set.
`email`	string	ja	darf null sein	Email address.
`phone`	string	ja	darf null sein	Phone number.
`fax`	string	ja	darf null sein	Fax number.
`website`	string	ja	darf null sein	Website.
`postal_address`	`StoredAddress`	ja	darf null sein	Postal address, e.g. for invoices.
`physical_address`	`StoredAddress`	ja	darf null sein	Physical address, if it differs from the postal address — e.g. where passengers are dropped off.
`notes`	string	ja	darf null sein	Notes of the operator.
`created_at`	string	ja	darf null sein	When the customer was created (ISO 8601 with offset).
`updated_at`	string	ja		When the customer was last changed (ISO 8601 with offset).
`billing`	`CustomerBilling`	nein		Billing data. Only with `include=billing` and the scope `accounting.read`.

Abrechnungsdaten (Kunde) `CustomerBilling`

Billing data. Only with include=billing and the scope accounting.read.

Feld	Typ	Pflicht	Werte	Beschreibung
`tax_id`	string	ja	darf null sein	Tax number.
`vat_id`	string	ja	darf null sein	VAT ID.
`buyer_reference`	string	ja	darf null sein	Buyer reference for e-invoices (Leitweg-ID in Germany).
`payment_method`	string	ja	darf null sein	Payment method as entered by the operator, free text.
`bank_account`	`BankAccount`	ja	darf null sein	Bank account; `null` when none is stored.

Bankverbindung `BankAccount`

Bank account as stored. Empty parts are null.

Feld	Typ	Pflicht	Werte	Beschreibung
`account_holder`	string	ja	darf null sein	Account holder.
`bank_name`	string	ja	darf null sein	Name of the bank.
`iban`	string	ja	darf null sein	IBAN.
`bic`	string	ja	darf null sein	BIC.

Gespeicherte Anschrift `StoredAddress`

Address as stored in Fleetiva. Empty parts are null.

Feld	Typ	Pflicht	Werte	Beschreibung
`street`	string	ja	darf null sein	Street.
`house_number`	string	ja	darf null sein	House number.
`zip`	string	ja	darf null sein	Postal code.
`city`	string	ja	darf null sein	City.
`country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.
`address_line_2`	string	ja	darf null sein	Address supplement, e.g. building or floor.
`po_box`	string	ja	darf null sein	PO box, instead of a street.
`department`	string	ja	darf null sein	Department.
`attention`	string	ja	darf null sein	For the attention of a person.
`reference`	string	ja	darf null sein	Reference of the addressee, e.g. a file number.

Fahrgast (Stammdaten) `PassengerRecord`

A passenger of the transport service.

Feld	Typ	Pflicht	Werte	Beschreibung
`id`	string	ja		ID of the passenger.
`number`	string	ja	darf null sein	Passenger number assigned by the operator.
`status`	string	ja	eins von: `active`, `inactive`, `archived` darf null sein	`active`, `inactive` or `archived`. `null` when not set.
`self_payer`	boolean	ja		The passenger pays for their trips themselves: they belong to the system customer for self-payers (`customer.number` `SELBSTZAHLER`), however often they ride.
`salutation`	string	ja	eins von: `mr`, `ms`, `diverse` darf null sein	`mr`, `ms` or `diverse`. `null` when not set.
`first_name`	string	ja	darf null sein	First name.
`last_name`	string	ja		Last name.
`date_of_birth`	string	ja	darf null sein	Date of birth (`YYYY-MM-DD`).
`email`	string	ja	darf null sein	Email address.
`phone_numbers`	Liste von object	ja		Phone numbers with a label, e.g. mobile or mother. Empty list when none.
`phone_numbers[].label`	string	ja	darf null sein	Whose number, e.g. mother.
`phone_numbers[].number`	string	ja		Phone number.
`home_address`	`StreetAddress`	ja	darf null sein	Home address — where the passenger is usually picked up.
`customer`	object	ja	darf null sein	The customer (cost bearer) the passenger belongs to. Read the customer itself to sync it.
`customer.id`	string	ja		ID of the customer.
`customer.name`	string	ja		Name of the customer at the time of reading.
`customer.number`	string	ja	darf null sein	Customer number.
`reference_codes`	Liste von object	ja		Reference codes of cost bearers, as printed on documents. Empty list when none.
`reference_codes[].type`	string	ja		Kind of reference, e.g. approval number.
`reference_codes[].value`	string	ja		Value.
`needs`	`PassengerNeeds`	ja		What the passenger needs on the trip — vehicle, seat and help. Same keys as `needs` of an inquiry.
`seat_preference`	string	ja	eins von: `no_preference`, `front`, `rear` darf null sein	`front`, `rear` or `no_preference`. `null` when not recorded.
`boarding_minutes`	number	ja	darf null sein	Minutes the passenger usually needs to board.
`pickup_earliest`	string	ja	darf null sein	Usual earliest pickup time (`HH:MM`, local time of the operator).
`pickup_latest`	string	ja	darf null sein	Usual latest pickup time (`HH:MM`, local time of the operator).
`notes`	string	ja	darf null sein	Notes of the operator.
`created_at`	string	ja	darf null sein	When the passenger was created (ISO 8601 with offset).
`updated_at`	string	ja		When the passenger was last changed (ISO 8601 with offset).
`health`	`PassengerHealth`	nein		Health data (Art. 9 GDPR). Only for API keys with the scope `health_data` and `include=health`. Every passenger delivered with this group is logged for the operator.
`billing`	`PassengerBilling`	nein		Billing data. Only with `include=billing` and the scope `accounting.read`.

Bedarfe (Fahrgast) `PassengerNeeds`

What the passenger needs on the trip — vehicle, seat and help. Same keys as needs of an inquiry.

Feld	Typ	Pflicht	Beschreibung
`wheelchair`	boolean	ja	Travels seated in the wheelchair (needs a wheelchair space and a ramp or lift). `false` when not recorded.
`wheelchair_transferable`	boolean	ja	Uses a wheelchair but can move to a regular seat for the trip. `false` when not recorded.
`rollator`	boolean	ja	Brings a rollator. `false` when not recorded.
`walker`	boolean	ja	Uses a walking frame. `false` when not recorded.
`cane`	boolean	ja	Uses a walking stick. `false` when not recorded.
`ambulatory`	boolean	ja	Can walk without help. `false` when not recorded.
`stretcher`	boolean	ja	Travels lying on a stretcher. `false` when not recorded.
`oxygen`	boolean	ja	Needs oxygen during the trip (needs an oxygen-equipped vehicle). `false` when not recorded.
`companion`	boolean	ja	Needs an escort provided by the transport service. `false` when not recorded.
`boarding_assistance`	boolean	ja	Needs help getting in and out of the vehicle. `false` when not recorded.
`assistance`	boolean	ja	Needs support during the trip. `false` when not recorded.
`service_animal`	boolean	ja	Travels with an assistance animal. `false` when not recorded.
`bicycle`	boolean	ja	Brings a bicycle. `false` when not recorded.

Gesundheitsdaten (Fahrgast) `PassengerHealth`

Health data (Art. 9 GDPR). Only for API keys with the scope health_data and include=health. Every passenger delivered with this group is logged for the operator.

Feld	Typ	Pflicht	Werte	Beschreibung
`medical_notes`	string	ja	darf null sein	Medical notes for the trip.
`allergies`	string	ja	darf null sein	Allergies.
`emergency_contact`	`EmergencyContact`	ja	darf null sein	Emergency contact; `null` when none is stored.
`needs_notes`	string	ja	darf null sein	Free text about the needs, e.g. how to help with boarding.
`autism`	boolean	ja		The passenger is autistic. `false` when not recorded.
`visual_impairment`	boolean	ja		The passenger has a visual impairment. `false` when not recorded.
`cognitive_impairment`	boolean	ja		The passenger has a cognitive impairment. `false` when not recorded.

Notfallkontakt `EmergencyContact`

Emergency contact as stored. Empty parts are null.

Feld	Typ	Pflicht	Werte	Beschreibung
`name`	string	ja	darf null sein	Name of the contact person.
`relationship`	string	ja	darf null sein	Relationship to the passenger, e.g. mother.
`phone`	string	ja	darf null sein	Phone number.

Abrechnungsdaten (Fahrgast) `PassengerBilling`

Billing data. Only with include=billing and the scope accounting.read.

Feld	Typ	Pflicht	Werte	Beschreibung
`name`	string	ja	darf null sein	Name on invoices, if it differs from the passenger.
`address`	`StreetAddress`	ja	darf null sein	Billing address; `null` when none is stored. If neither `name` nor `address` is set, documents are addressed to the passenger at `home_address`.
`default_tax_rate`	number	ja	darf null sein	Default VAT rate in percent for documents of this passenger.

Anschrift `StreetAddress`

Address with street, house number, postal code, city and country. Empty parts are null.

Feld	Typ	Pflicht	Werte	Beschreibung
`street`	string	ja	darf null sein	Street.
`house_number`	string	ja	darf null sein	House number.
`zip`	string	ja	darf null sein	Postal code.
`city`	string	ja	darf null sein	City.
`country`	string	ja	darf null sein	Country as stored, e.g. `DE` or `Deutschland`.

Gelöschter Datensatz `DeletedRecord`

A record that no longer exists. Remove it from your copy.

Feld	Typ	Pflicht	Werte	Beschreibung
`id`	string	ja		ID of the deleted record.
`deleted_at`	string	ja		When it was deleted (ISO 8601 with offset).

Fehlerantwort `Problem`

Error response (RFC 9457, application/problem+json).

Feld	Typ	Pflicht	Werte	Beschreibung
`type`	string	ja		Stable identifier of the problem: `tag:fleetiva.de,2026:api/problems/<code>`.
`title`	string	ja		Short English summary.
`status`	integer	ja	-9007199254740991–9007199254740991	HTTP status code, same as the response status.
`code`	string	ja	eins von: `unauthorized`, `forbidden`, `access_inactive`, `not_found`, `invalid_input`, `idempotency_key_reused`, `payload_too_large`, `unsupported_media_type`, `rate_limited`, `unavailable`	Machine-readable error code — branch on this.
`request_id`	string	ja		ID of this request, also in the `X-Request-Id` header. Quote it when you contact support.
`issues`	Liste von object	nein		Only with `invalid_input`: what is wrong where. Never repeats the submitted values.
`issues[].path`	string	ja		Field path such as `passengers.0.pickup.city` or `idempotency_key`; empty for the whole body.
`issues[].message`	string	ja	eins von: `required`, `too_short`, `too_long`, `too_few`, `too_many`, `too_small`, `too_large`, `invalid_type`, `invalid_value`, `invalid_format`, `unknown_field`, `invalid_json`, `invalid_characters`, `contact_required`, `address_incomplete`, `invalid_date`, `in_future`, `return_time_requires_return_trip`, `invalid_cursor`, `sync_window_exceeded`	Fixed reason code — branch on this. The list only grows; treat an unknown code like `invalid_value`.
`issues[].limit`	number	nein		With `too_short`, `too_long`, `too_few`, `too_many`, `too_small`, `too_large`: the limit that was broken.
`retry_after_seconds`	integer	nein	1–9007199254740991	Only with `rate_limited`: seconds to wait, same as the `Retry-After` header.

API-Referenz

Anfragen

POST/inquiries

Parameter

Inhalt (JSON)

Antworten

Felder der Antwort

Beispiel

Ausprobieren

GET/inquiries/{id}

Parameter

Antworten

Felder der Antwort

Beispiel

Ausprobieren

Kunden

GET/customers

Parameter

Antworten

Felder der Antwort

Beispiel

Ausprobieren

GET/customers/{id}

Parameter

Antworten

Felder der Antwort

Beispiel

Ausprobieren

GET/customers/deleted

Parameter

Antworten

Felder der Antwort

Beispiel

Ausprobieren

Fahrgäste

GET/passengers

Parameter

Antworten

Felder der Antwort

Beispiel

Ausprobieren

GET/passengers/{id}

Parameter

Antworten

Felder der Antwort

Beispiel

Ausprobieren

GET/passengers/deleted

Parameter

Antworten

Felder der Antwort

Beispiel

Ausprobieren

Datenformate

Anfragende Person Requester

Fahrgast (Anfrage) Passenger

Adresse Address

Bedarfe Needs

Einwilligung Consent

Kunde Customer

Abrechnungsdaten (Kunde) CustomerBilling

Bankverbindung BankAccount

Gespeicherte Anschrift StoredAddress

Fahrgast (Stammdaten) PassengerRecord

Bedarfe (Fahrgast) PassengerNeeds

Gesundheitsdaten (Fahrgast) PassengerHealth

Notfallkontakt EmergencyContact

Abrechnungsdaten (Fahrgast) PassengerBilling

Anschrift StreetAddress

Gelöschter Datensatz DeletedRecord

Fehlerantwort Problem

POST`/inquiries`

GET`/inquiries/{id}`

GET`/customers`

GET`/customers/{id}`

GET`/customers/deleted`

GET`/passengers`

GET`/passengers/{id}`

GET`/passengers/deleted`

Anfragende Person `Requester`

Fahrgast (Anfrage) `Passenger`

Adresse `Address`

Bedarfe `Needs`

Einwilligung `Consent`

Kunde `Customer`

Abrechnungsdaten (Kunde) `CustomerBilling`

Bankverbindung `BankAccount`

Gespeicherte Anschrift `StoredAddress`

Fahrgast (Stammdaten) `PassengerRecord`

Bedarfe (Fahrgast) `PassengerNeeds`

Gesundheitsdaten (Fahrgast) `PassengerHealth`

Notfallkontakt `EmergencyContact`

Abrechnungsdaten (Fahrgast) `PassengerBilling`

Anschrift `StreetAddress`

Gelöschter Datensatz `DeletedRecord`

Fehlerantwort `Problem`