ticketing > Tickets

Find Ticket

Retrieves ticket id and access details about a specific ticket or list of tickets, depending on which query parameter is used. If the value is not found, an empty list is returned. In case when a list of external numbers is provided, all matching tickets are returned, including duplicates. Tickets not found are omitted from the result. Leading and trailing spaces are ignored in the provided ticket numbers. <br>Exactly one of ticketId, externalNumbers or notificationAddress must be provided.<br> <br> - Filter using ticketId, externalNumbers or notificationAddress to get a specific ticket or a list of tickets. <br> - Use externalNumbers to find multiple tickets by their external numbers. (Separate the ticket number with a comma). <br> - Admission content and item descriptions can be included with withAdmissionContent. <br> - Access history summary is always included; use withAccessHistoryDetails to also include event-level events. <br> - activeOnly controls whether blocked/expired tickets are filtered out (defaults to true when omitted).

get/{tenant}/{environment}/{company}/ticket

Path parameters

tenantstring required

Your Entra Tenant ID. More details.

environmentstring required

Your Business Central Environment. More details.

companystring required

Your Business Central Company. More details.

Query parameters

externalNumbersTypesSimpleTicketExternalNumbers — unresolved $ref
ticketIdTypesSimpleTicketId — unresolved $ref
notificationAddressTypesSimpleNotificationAddress — unresolved $ref
withAdmissionContentboolean
withAccessHistoryDetailsboolean
activeOnlyboolean
storeCodeTypesSimpleStoreCode — unresolved $ref

Headers

x-np-api-keystring required
x-api-versionstring date

Used for API versioning. More details.

Response

Response with status 200

TypesCompositeFindTicketResponse[] required— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.