- Introduction
- Quickstart
- Webhooks
- Campaign
- Class
- Client
- Retrieves all client for a TenantGET
- Creates a new clientPOST
- Gets client by IDGET
- Gets clients birthday listGET
- Gets clients at riskGET
- Gets client mandatory fieldsGET
- Adds client to blacklistPOST
- Removes client from blacklistPOST
- Updates client detailsPUT
- Used for partial updates of client detailsPATCH
- Changes client representativePOST
- Lists prospectsGET
- Lists ex-clientsGET
- Resets client passwordPOST
- Changes client representative for multiple clientsPOST
- Lists prospect effective date historyGET
- Transfers prospectPOST
- Company
- Invoice
- Organisation
- Search
- Tax
- Tenant
- Appointments
- Create new appointment
- List appointments
- Change client membership in appointment
- Get appointment
- Update appointment
- Mark client as checked in
- Mark client as no-show
- Substitute coach for appointment
- Reschedule appointment
- Cancel appointment
- List appointments by client ID
- Create appointment complimentory session
- Create appointment
- Reschedule appointment
- Get appointment
- Appointment Types
- Authentication
- Automation
- Call Transactions
- Charge Categories
- Charge Master
- Recurring Class
- Class Booking
- Class Complimentory
- Class Types
- Company level class types
- Client Communication
- Client Tasks
- Client Sales
- Client Waivers
- Client Sessions
- Client Referrals
- Client Offers
- Client Export
- Client Billing
- Client Check-in
- Client Credit Balance
- Client Documents
- Client Invoices
- Client Membership
- Client Open API
- Client Payments
- Client Subscriptions
- Client Memberships
- Client Subscription Cancellation
- Client Subscription Freeze
- Client Trials
- Client Upgrade
- Balance Write Off
- Email Template
- Email Template - Franchise
- Create email template at franchise level
- Get list of email templates at franchise level
- Update email template at franchise level
- Get email template at franchise level
- Delete email template at franchise level
- Mark email template as inactive at franchise level
- Mark email template as active at franchise level
- Email Template - Tenant
- Franchise Groups
- Payment Methods
- Invoices
- Offer Master
- Online Signup
- Subscription
- Sales
- Staff Availability
- List staff availability
- List staff availability by appointment category
- List next available slots by appointment category
- Check staff availability
- Check staff availability for appointment category
- Check staff availability for recurring schedule
- Check staff availability for recurring schedule
- Get staff scheduled unavailability
- List staff availability for tours
- Opportunities
- Opportunity Stage Master
- Payments
- Refunds
- Reports
- Report Filter Schedules
- Access Requests
- Rooms
- Sales Returns
- Email Communication
- SMS
- Service Categories
- Staff Management
- Staff Appointment Type Link
- Staff Notifications
- Staff Schedule
- Subscription Plans
- Subscription Signup
- Tasks
- Task Categories
- Task Open API
- Trial Master
Get automation by company
GET
/company/automation/ownership/company
Campaign
Request
None
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/company/automation/ownership/company'
Responses
🟢200OK
text/plain
Body
array of:
guid
string  | nullÂ
optional
automation_name
string  | nullÂ
optional
automation_description
string  | nullÂ
optional
automation_status
enum<string>Â
optional
InActive
-Active
-Allowed values:
InActiveActive
ownershiplevel
enum<string>Â
optional
Company
-Franchise
-Tenant
-Allowed values:
CompanyFranchiseTenant
created_by
integer <int32>
optional
created_date
string <date-time>
optional
updated_by
integer <int32>
optional
updated_date
string <date-time>
optional
automation_event_type
enum<string>Â
optional
Campaign
-auto_clt_sub_signup_completed
-auto_clt_sub_signup_failed
-auto_clit_birthday
-auto_clt_sub_signup_link_generated
-auto_clt_invoice_created
-auto_clt_non_recurring_payment_received
-auto_clt_waiver_completed
-Feedback
-ClientRenewalReminder
-auto_clt_flagged_clt_at_risk
-ClientSubscriptionActivation
-auto_clt_password_reset_triggered
-RequestAccess
-ClientProspectCreation
-auto_clt_transferor_consent_request_initiated
-auto_clt_sales_return_created
-auto_clt_refund_processed
-Other
-auto_clt_tour_booked
-auto_clt_recurring_appt_booked
-auto_clt_recurring_appt_rescheduled
-auto_clt_recurring_appt_cancelled
-auto_clt_single_appt_rescheduled
-auto_clt_single_appt_booked
-auto_clt_single_appt_date
-auto_clt_single_appt_cancelled
-auto_clt_single_appt_marked_attended
-auto_clt_single_appt_marked_noshow
-auto_clt_sub_cancellation_date
-auto_clt_class_waitlist_spot_vacated
-auto_clt_trial_start_date
-auto_clt_sub_start_date
-auto_clt_sub_end_date
-auto_clt_membership_end_date
-auto_clt_membership_start_date
-auto_clt_newlead_created
-auto_clt_tour_marked_noshow
-auto_clt_sub_cancellation_requested
-auto_clt_trial_end_date
-auto_clt_trial_created
-auto_clt_abandoned_sub_signup
-auto_clt_low_risk_clt_arrived
-auto_clt_moderate_risk_clt_arrived
-auto_clt_high_risk_clt_arrived
-auto_clt_pending_cancellation_clt_arrived
-auto_clt_appointee_arrived
-auto_class_rescheduled
-auto_class_coach_substituted
-auto_class_cancelled
-auto_clt_class_booked
-auto_clt_class_session_date
-auto_clt_class_booking_cancelled
-auto_clt_recurring_payment_received
-auto_clt_recurring_payment_failed
-auto_clt_invoice_voided
-auto_clt_payment_voided
-auto_clt_sales_return_voided
-auto_clt_sub_freeze_created
-auto_clt_sub_freeze_start_date
-auto_clt_sub_freeze_end_date
-auto_clt_sub_freeze_voided
-auto_clt_sub_freeze_stopped
-auto_clt_sub_voided
-auto_clt_tour_scheduled_date
-auto_clt_repeat_enq_created
-auto_clt_class_marked_attended
-auto_clt_class_marked_noshow
-manage_clt_sub_link
-invoice_clear_balance_link
-auto_generate_and_send_member_password
-auto_clt_initiate_otp_for_saved_card
-auto_clt_non_recurring_payment_failed
-auto_sdr
-auto_clt_otp_for_login
-auto_clt_waiver_pending_reminder
-auto_clt_trial_onboarding
-Allowed values:
Campaignauto_clt_sub_signup_completedauto_clt_sub_signup_failedauto_clit_birthdayauto_clt_sub_signup_link_generatedauto_clt_invoice_createdauto_clt_non_recurring_payment_receivedauto_clt_waiver_completedFeedbackClientRenewalReminderauto_clt_flagged_clt_at_riskClientSubscriptionActivationauto_clt_password_reset_triggeredRequestAccessClientProspectCreationauto_clt_transferor_consent_request_initiatedauto_clt_sales_return_createdauto_clt_refund_processedOtherauto_clt_tour_bookedauto_clt_recurring_appt_bookedauto_clt_recurring_appt_rescheduledauto_clt_recurring_appt_cancelledauto_clt_single_appt_rescheduledauto_clt_single_appt_bookedauto_clt_single_appt_dateauto_clt_single_appt_cancelledauto_clt_single_appt_marked_attendedauto_clt_single_appt_marked_noshowauto_clt_sub_cancellation_dateauto_clt_class_waitlist_spot_vacatedauto_clt_trial_start_dateauto_clt_sub_start_dateauto_clt_sub_end_dateauto_clt_membership_end_dateauto_clt_membership_start_dateauto_clt_newlead_createdauto_clt_tour_marked_noshowauto_clt_sub_cancellation_requestedauto_clt_trial_end_dateauto_clt_trial_createdauto_clt_abandoned_sub_signupauto_clt_low_risk_clt_arrivedauto_clt_moderate_risk_clt_arrivedauto_clt_high_risk_clt_arrivedauto_clt_pending_cancellation_clt_arrivedauto_clt_appointee_arrivedauto_class_rescheduledauto_class_coach_substitutedauto_class_cancelledauto_clt_class_bookedauto_clt_class_session_dateauto_clt_class_booking_cancelledauto_clt_recurring_payment_receivedauto_clt_recurring_payment_failedauto_clt_invoice_voidedauto_clt_payment_voidedauto_clt_sales_return_voidedauto_clt_sub_freeze_createdauto_clt_sub_freeze_start_dateauto_clt_sub_freeze_end_dateauto_clt_sub_freeze_voidedauto_clt_sub_freeze_stoppedauto_clt_sub_voidedauto_clt_tour_scheduled_dateauto_clt_repeat_enq_createdauto_clt_class_marked_attendedauto_clt_class_marked_noshowmanage_clt_sub_linkinvoice_clear_balance_linkauto_generate_and_send_member_passwordauto_clt_initiate_otp_for_saved_cardauto_clt_non_recurring_payment_failedauto_sdrauto_clt_otp_for_loginauto_clt_waiver_pending_reminderauto_clt_trial_onboarding
Example
[
{
"guid": "string",
"automation_name": "string",
"automation_description": "string",
"automation_status": "InActive",
"ownershiplevel": "Company",
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"automation_event_type": "Campaign"
}
]
Modified at 2025-03-21 07:23:14