API documentation

GET /schedule_actions/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/schedule_actions/:id

Get details about a schedule action.

Gets a schedule action's details by id, including the integrations available to it.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/schedule_actions/10001' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "action_lead_block": {
    "id": 10002,
    "type": "ScheduleAction",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/schedule/actions/10003",
    "routes_edit_path": "/schedule/actions/10003/edit",
    "external_record_id": null,
    "name": "Block Lead",
    "description": "Blocks the lead from further contact on this company",
    "schedule_id": 10004,
    "offer_id": 10005,
    "owner_relation": "actions",
    "sortable_order": 1,
    "action_type": "lead_block",
    "action_category": "choice",
    "add_one_to_lead_priority": null,
    "part_of_schedule": true,
    "can_postpone_processing_leads": false,
    "lead_retarget_id": null,
    "schedule_action_group_id": "a09e6bca-255b-4217-af73-cb9601c80217",
    "sms_body": null,
    "use_custom_caller_id": null,
    "custom_caller_id": null,
    "email_title": null,
    "email_body": null,
    "email_type": null,
    "email_from": null,
    "email_from_name": null,
    "email_domain": null,
    "email_to_name": null,
    "custom_email": null,
    "change_contact_caller_permission_required": null,
    "outgoing_webhook": {},
    "parent_outgoing_webhook_id": null,
    "call_disposition_id": null,
    "reassign_to_schedule": false,
    "action_wait_type": null,
    "wait_until_day_of_week": null,
    "wait_until_hour": null,
    "wait_until_minute": null,
    "wait_until_time_zone": null,
    "wait_seconds": null,
    "wait_minutes": null,
    "wait_hours": null,
    "wait_days": null,
    "choice_action_type": null,
    "sub_action": null,
    "add_to_schedule_id": null,
    "add_to_schedule_name": null,
    "mailchimp_list_id": null,
    "campaign_id": null,
    "ftp_hostname": null,
    "ftp_username": null,
    "ftp_directory_path": null,
    "ftp_file_name": null,
    "ftp_generate_directory": null,
    "ftp_upload_remote_file": true,
    "ftp_remote_file_url": null,
    "ftp_contents_to_upload": null,
    "use_sftp": false,
    "auth_public_key": null,
    "aws_region": null,
    "lead_wait_rule_group_id": null,
    "has_queued_leads": null,
    "queued_leads_count": null,
    "calls_on_hold_limit": null,
    "when_buyer_would_convert": null,
    "when_buyer_available": null,
    "off_hook_enabled": true,
    "available_cc_percentage": null,
    "change_instant_agent_dial_mode": null,
    "during_daylight_hours": null,
    "lead_alteration_ids": [],
    "lead_cycle_dial_number": false,
    "lead_cycle_sms_number": false,
    "zoho_crm_commands_count": 0,
    "zoho_crm_integration_id": null,
    "skip_contact_field_validations": false,
    "lead_update_all_matching_leads": null,
    "lead_unblock_contact": null,
    "lead_assign_trackdrive_number": null,
    "lead_assign_sms_number": null,
    "lead_expire_existing": null,
    "lead_delete_existing": null,
    "lead_update_only": null,
    "lead_restart_schedule": null,
    "lead_hours_to_expire": null,
    "lead_max_contact_attempts": null,
    "lead_block_type": "company",
    "use_custom_caller_number": null,
    "custom_caller_number_id": null,
    "integration_id": null,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": [],
    "record_token_additional_id": null,
    "record_token_additional_data_count": 0,
    "record_token_additional_data": [],
    "token_value_map_group_ids": null
  },
  "associations": {
    "integrations": [
      {
        "id": 10006,
        "type": "Integration",
        "uuid": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
        "created_at": "2026-01-15T14:30:00.000Z",
        "updated_at": "2026-01-15T14:30:00.000Z",
        "deleted_at": null,
        "user_updated_at": null,
        "routes_show_path": null,
        "routes_edit_path": "/integrations/10006/edit",
        "external_record_id": null,
        "integration_type": "facebook_leadads",
        "name": "Facebook Lead Ads",
        "public_key": null,
        "category": "leadgen",
        "category_name": "Lead Gen",
        "connected_status": null,
        "connected_at": null,
        "disconnected_at": null,
        "is_oauth2": false,
        "cache_expires_in": 900,
        "requests_24h": 0,
        "supports_sync": false
      },
      {
        "id": 10007,
        "type": "Integration",
        "uuid": "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
        "created_at": "2026-01-15T14:30:00.000Z",
        "updated_at": "2026-01-15T14:30:00.000Z",
        "deleted_at": null,
        "user_updated_at": null,
        "routes_show_path": null,
        "routes_edit_path": "/integrations/10007/edit",
        "external_record_id": null,
        "integration_type": "google_adwords",
        "name": "Google Ads",
        "public_key": null,
        "category": "tracking",
        "category_name": "Conversion Tracking",
        "connected_status": null,
        "connected_at": null,
        "disconnected_at": null,
        "is_oauth2": true,
        "cache_expires_in": 900,
        "requests_24h": 0,
        "supports_sync": false
      },
      {
        "id": 10008,
        "type": "Integration",
        "uuid": "1d4df925-d435-4b33-a461-efb6c324405e",
        "created_at": "2026-01-15T14:30:00.000Z",
        "updated_at": "2026-01-15T14:30:00.000Z",
        "deleted_at": null,
        "user_updated_at": null,
        "routes_show_path": null,
        "routes_edit_path": "/integrations/10008/edit",
        "external_record_id": null,
        "integration_type": "salesforce",
        "name": "Salesforce CRM",
        "public_key": null,
        "category": "crm",
        "category_name": "CRM Software",
        "connected_status": null,
        "connected_at": null,
        "disconnected_at": null,
        "is_oauth2": false,
        "cache_expires_in": 900,
        "requests_24h": 0,
        "supports_sync": false
      }
    ]
  },
  "metadata": {
    "root": "action_lead_block"
  }
}