1. API Endpoints

Amtify provides a RESTful API that allows developers to integrate Bürgeramt appointment booking functionality into their own applications. The API uses API Keys for authentication and accepts JSON payloads for requests and responses.

Create Appointment Search Request#

Method: POST
Endpoint: /v1/appointments
Description: Initiates a new appointment search request

Check Search Status#

Method: GET
Endpoint: /v1/appointments/{id}
Description: Retrieves the current status of a specific appointment search

Cancel Search Request#

Method: DELETE
Endpoint: /v1/appointments/{id}
Description: Cancels an ongoing appointment search request

List Available Bürgeramt Locations#

Method: GET
Endpoint: /v1/locations
Description: Retrieves a list of all available Bürgeramt locations

List Available Services#

Method: GET
Endpoint: /v1/services
Description: Retrieves a list of all available services that can be booked