- 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 campaign by GUID
GET
/company/automation/{guid}
Request
Path Params
Request Code 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/'Responses
🟢200OK
text/plain
Body
Example
{
"campaign_id": 0,
"company_id": 0,
"campaign_name": "string",
"campaign_description": "string",
"campaign_action_status": "Scheduled",
"campaign_status": "InActive",
"ownership_level": "Company",
"franchise_id": 0,
"trackMode": "StaffWebApp",
"guid": "string",
"campaign_event_type": "Campaign",
"notification_staff": {
"notify_record_associated_staff": true,
"notify_additional_staff_to": [
0
]
},
"created_by": 0,
"created_date": "2019-08-24T14:15:22Z",
"updated_by": 0,
"updated_date": "2019-08-24T14:15:22Z",
"tenant_ids": [
0
],
"deletd_marked_tenant_ids": [
0
],
"actions_group": {
"campaign_action_date": "2019-08-24T14:15:22Z",
"source_data_type": "Rules",
"source_data_extraction_rules": {
"reports": {
"report_key": "SubscriptionSignUpReport",
"relative_date": "Yesterday",
"payload": "string"
},
"clients": [
0
],
"rule": {
"sql": "string",
"params": {
"property1": null,
"property2": null
}
},
"jsonrule": {
"sql": "string",
"params": {
"property1": null,
"property2": null
}
}
},
"action_payload": [
{
"actions": {
"client_email_action_payload": {
"email_template_master_id": 0,
"email_from_config_id": 0,
"subject": "string",
"body": "string"
},
"client_sms_action_payload": {
"sms_template_master_id": 0,
"message": "string",
"sms_sender_config_id": 0
},
"client_whatsapp_action_payload": {
"whatsapp_template_master_uuid": "string",
"message": "string",
"whatsapp_sender_config_id": 0
},
"client_pushnotification_action_payload": {
"push_notification_template_master_id": 0,
"push_from_config_id": 0,
"tile": "string",
"image": "string",
"body": "string"
},
"staff_email_action_payload": {
"email_template_master_id": 0,
"email_from_config_id": 0,
"subject": "string",
"body": "string"
},
"staff_sms_action_payload": {
"sms_template_master_id": 0,
"message": "string",
"sms_sender_config_id": 0
},
"staff_whatsapp_action_payload": {
"whatsapp_template_master_uuid": "string",
"message": "string",
"whatsapp_sender_config_id": 0
},
"staff_task_action_payload": {
"assigned_to_type": "SpecificStaff",
"assigned_to_staff_id": 0,
"type": "Call",
"category_id": 0,
"category_name": "string",
"title": "string",
"notes": "string",
"priority": "High",
"scheduled_date": "2019-08-24T14:15:22Z"
},
"staff_pushnotification_action_payload": {
"push_notification_template_master_id": 0,
"push_from_config_id": 0,
"tile": "string",
"image": "string",
"body": "string"
},
"notification_staff": {
"notify_record_associated_staff": true,
"notify_additional_staff_to": [
0
]
}
},
"schedule_in_min": 0
}
]
}
}Modified at 2025-03-21 07:23:14