Retrieve the list of reasons

This API retrieves the list of specific reasons that a center's front-desk executives can select from when they cancel a membership, cancel an appointment, or mark a guest as a turnaway.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Response Details

NameTypeDescription
reasonpkintReason pk details.
idguidUnique 32-character identifier of the reason.
codestringReason code.
namestringName of the reason.
descriptionstringDescription about the reason.
object_typeenumIndicates the reasons belong to which type or category: 0 - Membership, 1 - Turnaways, 2 - Appointment, 3 - Deletion, and 4 - LoyaltyPoints.
action_typeenumIndicates the action type of the reason: 0 - Cancel and 1 - Update.
Default value: 0.
activebooleanIndicates whether the reason is currently active.
show_in_online_bookingbooleanIndicates whether the reason is to be displayed during online cancellations.
ErrorobjectObject that contains error message and error code details.
Query Params
int32

Optional Current page number of the list of reasons that is to be displayed.

int32

Optional Number of records that are to be displayed per page.

boolean

Optional Indicates whether to sort in ascending order while displaying the reasons.

string

Optional Retrieves only details that contains the specified search text.

int32

Optional Display the total count of rows.

boolean

Optional Indicates whether auto-suggestions are to be provided.

int32

Optional Reason object type.

int32

Optional Action object type.

boolean

Optional Indicates whether the reason is currently active.

boolean

Optional Indicates whether the reason is to be displayed during online cancellations.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json