REST API routes

The REST API is versioned under api.pl/v1 and uses bearer tokens with scopes.

Core routes

  • GET /v1/ping – Check availability

  • GET /v1/openapi.json – Retrieve the OpenAPI description

  • GET /v1/me – Retrieve information about the token in use

  • GET /v1/tickets – List tickets

  • POST /v1/tickets – Create a ticket

  • GET /v1/tickets/{ticket_id} – Read a ticket

  • PATCH /v1/tickets/{ticket_id} – Change ticket properties

  • GET /v1/tickets/{ticket_id}/articles – List articles

  • POST /v1/tickets/{ticket_id}/articles – Create an article

  • GET /v1/attachments/{attachment_id} – Download an attachment

  • GET /v1/master-data/{type} – Read queues, statuses, priorities, services, SLAs, or dynamic fields

  • GET /v1/customers and POST /v1/customers – Read or create customers

  • PATCH /v1/customers/{customer_id} – Change a customer

  • GET /v1/customer-users and POST /v1/customer-users – Read or create customer users

  • PATCH /v1/customer-users/{customer_user_id} – Change a customer user

Permission scopes

The source uses scopes including tickets.read, tickets.create, tickets.articles, tickets.attachments, tickets.status, tickets.properties, tickets.internal_notes, master_data.read, customers.read, and customers.write. Add-ons can register their own scopes and routes in their namespace.