{
    "variable": [
        {
            "id": "baseUrl",
            "key": "baseUrl",
            "type": "string",
            "name": "string",
            "value": "https:\/\/openapi.sweepandgo.com"
        }
    ],
    "info": {
        "name": "Sweep&Go - Open API",
        "_postman_id": "1b27acdd-bce0-4dc7-a2fa-7a6e629d3076",
        "description": "Sweep&Go - Open API description",
        "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json"
    },
    "item": [
        {
            "name": "Access token",
            "description": "\nEndpoints for generating, retrieving, and managing API access tokens.",
            "item": [
                {
                    "name": "List API access tokens",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/token_generate\/access_tokens",
                            "query": [
                                {
                                    "key": "organization_id",
                                    "value": "2",
                                    "description": "Organization ID.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/token_generate\/access_tokens?organization_id=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns all API access tokens for the given organization, including masked token values, webhook URLs, and enabled events.",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "[\n   {\n   \"data\": [\n     {\n       \"id\": 12,\n       \"token\": \"************************************************************XLtm\",\n       \"webhooks_url\": \"https:\/\/example.com\/webhooks\",\n       \"description\": \"First token\",\n       \"enabled_events\": [\n         \"client:client_onboarding_onetime\",\n         \"client:client_recurring_employee_portal\"\n       ]\n     },\n     {\n       \"id\": 18,\n       \"token\": \"************************************************************9P4a\",\n       \"webhooks_url\": \"https:\/\/example.com\/webhooks\",\n       \"description\": \"Second token\",\n       \"enabled_events\": [\n         \"client:client_onboarding_onetime\"\n       ]\n     }\n   ],\n   \"webhooks\": {\n\"free:quote\": \"Free quote\",\n\"lead:out_of_service_area\": \"Lead - out of service area\",\n\"lead:in_service_area\": \"Lead - in service area\",\n\"lead:delete\": \"Lead - deleted\",\n\"client:changed_status\": \"Client - changed status\",\n\"client:changed_info\": \"Client - changed info\",\n\"client:changed_address\": \"Client - changed address\",\n\"client:client_onboarding_recurring\": \"Client - client onboarding recurring\",\n\"client:client_onboarding_onetime\": \"Client - client onboarding onetime\",\n\"client:subscription_created\": \"Client - subscription created\",\n\"client:subscription_canceled\": \"Client - subscription canceled\",\n\"client:subscription_paused\": \"Client - subscription paused\",\n\"client:subscription_unpaused\": \"Client - subscription unpaused\",\n\"client:invoice_finalized\": \"Client - invoice finalized\",\n\"client:client_no_assigned\": \"Client - client no assigned\",\n\"client:client_assigned\": \"Client - client assigned\",\n\"client:subscription_cancel_requested\": \"Client - subscription cancel requested\",\n\"client:notification_settings_changed\": \"Client - notification settings changed\",\n\"client:additional_contact_changed\": \"Client - additional contact changed\",\n\"client:client_payment_declined\": \"Client - client payment declined\",\n\"client:client_payment_accepted\": \"Client - client payment accepted\",\n\"client:reviews_automation\": \"Client - reviews automation\",\n\"client:areas_to_clean_changed\": \"Client - areas to clean changed\",\n\"notification:on_the_way_notification\": \"Notification - on the way notification\",\n\"notification:off_schedule_notification\": \"Notification - off schedule notification\",\n\"notification:completed_job_notification\": \"Notification - completed job notification\",\n\"notification:skipped_job_notification\": \"Notification - skipped job notification\",\n\"notification:client_not_assigned\": \"Notification - Client not assigned\",\n\"staff:staff_clock_in\": \"Staff - staff clock in\",\n\"staff:staff_forgot_to_clock_out\": \"Staff - staff forgot to clock out\",\n\"staff:shift_break_started\": \"Staff - shift break started\",\n\"staff:shift_break_info\": \"Staff - shift break info\",\n\"job:started\": \"Job - started with info\",\n\"job:completed\": \"Job - completed with info start time, end time, job type and price\",\n\"organization:client_onboarding_form_changed\": \"Business - client onboarding form changed\",\n\"organization:cross_sells_changed\": \"Business - cross sells changed\",\n\"payroll:shift_info\": \"Payroll - shift info, work time, start time, end time, mileages, duration, break duration\",\n\"payroll:tip_info\": \"Payroll - tip linked to invoice with amount\",\n\"dog:birthday\": \"Send webhook on dog birthday 7 days in advance\",\n\"client:credit_card_link_created\": \"Private credit card link created for add new credit card\"\n}\n}\n]",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get API access token details",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/token_generate\/access_token\/:id",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/token_generate\/access_token\/:id",
                            "variable": [
                                {
                                    "id": "id",
                                    "key": "id",
                                    "value": "12",
                                    "description": "The ID of the access token."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the masked API token after it has been generated.",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n             \"token\":\"lrLxIj3PmNkSKdsFdTYYrfLFSungwVl4vXUk9alQo3Zu6cCGpslCGfHI9k2wXLtm\",\n             \"_id\": 12\n             }",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Generate API access token",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/token_generate\/access_token",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/token_generate\/access_token"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"organization_id\":2,\"webhooks_url\":\"https:\\\/\\\/example.com\\\/webhooks\",\"enabled_events\":[\"qui\"],\"description\":\"Webhooks for client onboarding events\"}"
                        },
                        "description": "Creates a new API access token for the given organization."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"token\":\"lrLxIj3PmNkSKdsFdTYYrfLFSungwVl4vXUk9alQo3Zu6cCGpslCGfHI9k2wXLtm\", \"_id\":12}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Delete API access token",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/token_generate\/access_token\/:id\/delete",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/token_generate\/access_token\/:id\/delete",
                            "variable": [
                                {
                                    "id": "id",
                                    "key": "id",
                                    "value": "ut",
                                    "description": "The ID of the access token."
                                }
                            ]
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Deletes an API access token."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\":\"success\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Tests",
            "description": "\nEndpoints used for health and availability checks.",
            "item": [
                {
                    "name": "API health check",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/health",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/health"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the current status of the API.\nThis endpoint can be used by monitoring services to verify that the API is running and reachable.",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"status\":\"OK\", \"version\": \"v1\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Test v1 API endpoint",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/welcome",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/welcome"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Echoes back the received request payload and triggers a test webhook event for the specified organization."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n   \"success\": \"v1\",\n   \"request\": {\n     \"example_param\": \"example_value\"\n   }\n }",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Test v2 API endpoint",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/welcome",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/welcome"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Echoes back the received request payload."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n   \"success\": \"v2\",\n   \"request\": {\n     \"example_param\": \"example_value\"\n   }\n }",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Clients list",
            "description": "\nEndpoints for retrieving and searching clients within an organization.",
            "item": [
                {
                    "name": "Get active clients",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/clients\/active",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "2",
                                    "description": "Get results for specific page.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v1\/clients\/active?page=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a paginated list of active clients."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"data\": [\n{\n\"client\": \"rcl_MTPQPRUUUY7G\",\n\"status\": \"active\",\n\"type\": \"employee_portal\",\n\"email\": \"demo@mail.com\",\n\"first_name\": \"John\",\n\"last_name\": \"Doe\",\n\"address\": \"3289 Summit Street\",\n\"zip_code\": \"52801\",\n\"home_phone\": null,\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\",\n\"subscription_names\": \"2w-3d,Deodorising\",\n\"one_time_client\": false,\n\"channel\": \"sms\",\n\"on_the_way\": true,\n\"completed\": true,\n\"off_schedule\": false,\n\"tracking_field\": \"utm_campaign=blog_post &utm_medium=social&utm_source=facebook\",\n\"service_days\": \"Monday\",\n\"assigned_to\": \"Alissa Doe\",\n\"cleanup_frequency\": \"once_a_week\"\n}\n],\n\"paginate\": {\n\"total\": 1,\n\"count\": 1,\n\"per_page\": 10,\n\"current_page\": 1,\n\"total_pages\": 1\n}\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get active clients without an active subscription",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/clients\/active_no_subscription",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "2",
                                    "description": "Get results for specific page.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v1\/clients\/active_no_subscription?page=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a paginated list of active clients that do not have any active subscriptions."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"data\": [\n{\n\"client\": \"rcl_MTPQPRUUUY7G\",\n\"status\": \"active\",\n\"type\": \"employee_portal\",\n\"email\": \"demo@mail.com\",\n\"first_name\": \"John\",\n\"last_name\": \"Doe\",\n\"address\": \"3289 Summit Street\",\n\"zip_code\": \"52801\",\n\"home_phone\": null,\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\",\n\"channel\": \"sms\",\n\"on_the_way\": true,\n\"completed\": true,\n\"off_schedule\": false,\n\"subscription_names\": \"2w-3d,Deodorising\",\n\"one_time_client\": false,\n\"tracking_field\": \"utm_campaign=blog_post &utm_medium=social&utm_source=facebook\",\n \"service_days\": \"Monday\",\n \"assigned_to\": \"Alissa Doe\",\n \"cleanup_frequency\": \"once_a_week\"\n}\n],\n\"paginate\": {\n\"total\": 1,\n\"count\": 1,\n\"per_page\": 10,\n\"current_page\": 1,\n\"total_pages\": 1\n}\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get inactive clients",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/clients\/inactive",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "2",
                                    "description": "Get results for specific page.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v1\/clients\/inactive?page=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a paginated list of inactive clients."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"data\": [\n{\n\"client\": \"rcl_MTPQPRUUUY7G\",\n\"status\": \"inactive\",\n\"type\": \"employee_portal\",\n\"email\": \"demo@mail.com\",\n\"first_name\": \"John\",\n\"last_name\": \"Doe\",\n\"address\": \"3289 Summit Street\",\n\"zip_code\": \"52801\",\n\"home_phone\": null,\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\",\n\"channel\": \"sms\",\n\"on_the_way\": true,\n\"completed\": true,\n\"off_schedule\": false,\n\"subscription_names\": \"\",\n\"one_time_client\": false,\n\"tracking_field\": \"utm_campaign=blog_post &utm_medium=social&utm_source=facebook\",\n \"service_days\": \"Monday\",\n \"assigned_to\": \"Alissa Doe\",\n \"cleanup_frequency\": \"once_a_week\"\n}\n],\n\"paginate\": {\n\"total\": 1,\n\"count\": 1,\n\"per_page\": 10,\n\"current_page\": 1,\n\"total_pages\": 1\n}\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get client details and payments",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/clients\/client_details",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/clients\/client_details"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"client\":\"rcl_MTPQPRUUUY7G\"}"
                        },
                        "description": "Returns client details along with payment history."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"client\": \"rcl_MTPQPRUUUY7G\",\n \"status\": \"active\",\n \"type\": \"employee_portal\",\n \"email\": \"demo@mail.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"address\": \"3289 Summit Street\",\n \"zip_code\": \"52801\",\n \"home_phone\": \"4155550110\",\n \"cell_phone\": \"2025550101\",\n \"marketing_allowed\": 1,\n \"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n \"marketing_allowed_source\": \"open_api\",\n \"channel\": \"sms\",\n \"on_the_way\": true,\n \"completed\": true,\n \"off_schedule\": false,\n \"tracking_field\": \"utm_campaign=blog_post &utm_medium=social&utm_source=facebook\",\n \"service_days\": \"Monday\",\n \"assigned_to\": \"Alissa Doe\",\n \"cleanup_frequency\": \"once_a_week\",\n \"subscription_names\": \"2d1W\",\n \"sum_payments\": 10.00,\n            \"payments\": [\n                                 {\n                                     \"id\": 1049219,\n                                     \"date\": \"2024-05-01\",\n                                     \"amount\": 139.43,\n                                     \"tip_amount\": \"5.00\",\n                                     \"status\": \"succeeded\",\n                                     \"type\": \"credit_card\",\n                                     \"description\": \"Payment for invoice(s) 199-66362-240501-2-1294170\",\n                                     \"created_at\": \"2024-05-01 11:19:38\"\n                                 },\n                                 {\n                                     \"id\": 1048709,\n                                     \"date\": \"2024-05-01\",\n                                     \"amount\": 139.43,\n                                     \"tip_amount\": \"0.00\",\n                                     \"status\": \"failed\",\n                                     \"type\": \"credit_card\",\n                                     \"description\": \"Payment for invoice(s) 199-66362-240501-2-1294170\",\n                                     \"created_at\": \"2024-05-01 11:11:13\"\n                                 }\n                       ]\n          }",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Search client by email",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/clients\/client_search",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/clients\/client_search"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"email\":\"john@doe.com\",\"status\":\"active\",\"latest\":true}"
                        },
                        "description": "Finds a client by email address and returns basic client details."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"client\": \"rcl_MTPQPRUUUY7G\",\n \"status\": \"active\",\n \"type\": \"employee_portal\",\n \"email\": \"john@doe.com\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"address\": \"3289 Summit Street\",\n \"zip_code\": \"52801\",\n \"home_phone\": \"4155550110\",\n \"cell_phone\": \"2025550101\",\n \"marketing_allowed\": 1,\n \"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n \"marketing_allowed_source\": \"open_api\",\n \"channel\": \"sms\",\n \"on_the_way\": true,\n \"completed\": true,\n \"off_schedule\": false,\n \"tracking_field\": \"utm_campaign=blog_post &utm_medium=social&utm_source=facebook\",\n \"service_days\": \"Monday\",\n \"assigned_to\": \"Alissa Doe\",\n \"cleanup_frequency\": \"once_a_week\",\n \"subscription_names\": \"2d1W\"\n }",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Onboarding new clients",
            "description": "\nEndpoints for onboarding new clients.",
            "item": [
                {
                    "name": "Onboard a new residential client in Sweep&Go",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/residential\/onboarding",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/residential\/onboarding"
                        },
                        "method": "PUT",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"zip_code\":\"12110\",\"number_of_dogs\":2,\"last_time_yard_was_thoroughly_cleaned\":\"one_week\",\"clean_up_frequency\":\"once_a_week\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"email\":\"mail@email.com\",\"city\":\"Latham\",\"home_address\":\"1494 Ben Street\",\"state\":\"TX\",\"home_phone_number\":\"4155550110\",\"cell_phone_number\":\"2025550101\",\"initial_cleanup_required\":1,\"cleanup_notification_type\":\"on_the_way,completed\",\"cleanup_notification_channel\":\"sms\",\"how_heard_about_us\":\"social_media\",\"how_heard_answer\":\"Facebook\",\"additional_comment\":\"Please clean my yard.\",\"credit_card_token\":\"tok_5678967890678 or 678987678909876\",\"name_on_card\":\"John Doe\",\"postal\":\"28301\",\"expiry\":\"0924\",\"dog_name\":[\"maiores\"],\"safe_dog\":[\"distinctio\"],\"dog_breed\":[\"sit\"],\"dog_comment\":[\"ex\"],\"cross_sells\":[1,2,5],\"cross_sells_names\":\"Spraying,Trash bags,Premium Cleanup\",\"coupon_code\":\"5pr1nG\",\"marketing_allowed\":1,\"marketing_allowed_source\":\"open_api\",\"areas_to_clean\":\"Front Yard, Back Yard\",\"gated_community\":\"67890\",\"gate_location\":\"left\",\"gate_code\":\"1234\",\"tracking_field\":\"utm_campaign=blog_post&utm_medium=social&utm_source=facebook\",\"terms_open_api\":1}"
                        },
                        "description": "Registers a new residential client in Sweep&Go.\nThis endpoint accepts client details, service preferences, notifications, dog information and optional payment details."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\": \"success\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Leads list",
            "description": "\nEndpoints for retrieving leads within an organization.",
            "item": [
                {
                    "name": "Get leads",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/leads\/list",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "2",
                                    "description": "Get results for specific page.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v1\/leads\/list?page=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a paginated list of leads."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"data\": [\n{\n\"lead\": \"rld_MTPQPRUUUY7G\",\n\"status\": \"active\",\n\"type\": \"onboarding_form\",\n\"email\": \"demo@mail.com\",\n\"name\": \"John Doe\",\n\"address\": \"3289 Summit Street\",\n\"zip_code\": \"52801\",\n\"home_phone\": null,\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\"\n}\n],\n\"paginate\": {\n\"total\": 1,\n\"count\": 1,\n\"per_page\": 10,\n\"current_page\": 1,\n\"total_pages\": 1\n}\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get out of area leads",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/leads\/out_of_service",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "2",
                                    "description": "Get results for specific page.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v1\/leads\/out_of_service?page=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a paginated list of leads that are out of service area."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"data\": [\n{\n\"lead\": \"rld_MTPQPRUUUY7G\",\n\"status\": \"lead\",\n\"type\": \"out_of_area\",\n\"email\": \"demo@mail.com\",\n\"name\": \"John Doe\",\n\"address\": \"3289 Summit Street\",\n\"zip_code\": \"52801\",\n\"home_phone\": null,\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\"\n}\n],\n\"paginate\": {\n\"total\": 1,\n\"count\": 1,\n\"per_page\": 10,\n\"current_page\": 1,\n\"total_pages\": 1\n}\n}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Dispatch Board",
            "description": "\nEndpoints for retrieving list of jobs.",
            "item": [
                {
                    "name": "Dispatch Board",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/dispatch_board\/jobs_for_date",
                            "query": [
                                {
                                    "key": "date",
                                    "value": "2022-03-28",
                                    "description": "Date to load the Dispatch Board for. Format must be YYYY-MM-DD.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v1\/dispatch_board\/jobs_for_date?date=2022-03-28"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the Dispatch Board job list for the selected date.\n\nNotes:\n- A job with `id` > 0 represents an already dispatched job record.\n- A job with `id` = 0 represents an undispatched job.\n\nSupported job status values:\n- pending (1)\n- completed (2)\n- skipped (3)\n- missed (4)\n- started (5)\n- dispatched (6)\n\nSupported job types:\n- custom\n- initial\n- one_time\n- reclean\n- recurring"
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"data\": [\n{\n\"id\": 0,\n\"client_location_id\": 2603,\n\"client_id\": null,\n\"commercial_location_id\": 142,\n\"commercial_client_id\": 84,\n\"pricing_plan_name\": \"Pet waste stations\",\n\"commercial\": 1,\n\"full_name\": \"Little Lambs Foundation for Kids\",\n\"address\": \"1011 W 400 N\",\n\"city\": \"Logan\",\n\"zip\": \"84321\",\n\"state_name\": \"Utah\",\n\"clean_up_frequency\": \"1xW\",\n\"count_cross_sells\": 1,\n\"assigned_to_name\": \"Bart Cage\",\n\"assigned_to_id\": 265,\n\"estimate_time\": \"00:15\",\n\"type\": \"recurring\",\n\"end_time\": null,\n\"start_time\": null,\n\"status_id\": 1,\n\"status_name\": \"pending\",\n\"duration\": \"-\",\n\"gate_code\": null,\n\"gated_community\": null,\n\"lat\": 41.7389868,\n\"lng\": -111.860119,\n\"number_of_dogs\": null,\n\"safe_dogs\": null,\n\"home_phone\": \"4155550110\",\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\",\n\"email\": \"demo@demo.com\"\n},\n{\n\"id\": 0,\n\"client_location_id\": 2726,\n\"client_id\": 1580,\n\"commercial_location_id\": null,\n\"commercial_client_id\": null,\n\"pricing_plan_name\": \"Regular Plan\",\n\"commercial\": 0,\n\"full_name\": \"Cara Deen\",\n\"address\": \"625 South 100 West\",\n\"city\": \"Garland\",\n\"zip\": \"84312\",\n\"state_name\": \"Utah\",\n\"clean_up_frequency\": \"two_times_a_week\",\n\"count_cross_sells\": 0,\n\"assigned_to_name\": \"Richard Dawson\",\n\"assigned_to_id\": 258,\n\"estimate_time\": \"00:15\",\n\"type\": \"recurring\",\n\"end_time\": null,\n\"start_time\": null,\n\"status_id\": 1,\n\"status_name\": \"pending\",\n\"duration\": \"-\",\n\"gate_code\": null,\n\"gated_community\": null,\n\"lat\": 41.7344582,\n\"lng\": -112.1634671,\n\"number_of_dogs\": 2,\n\"safe_dogs\": \"\",\n\"home_phone\": \"4155550110\",\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\",\n\"email\": \"demo@demo.com\"\n},\n{\n\"id\": 156608,\n\"client_location_id\": 2325,\n\"type\": \"recurring\",\n\"organization_id\": 158,\n\"client_id\": null,\n\"full_name\": \"Community Garden\",\n\"address\": \"468 1\/2 S 200 W\",\n\"city\": \"Logan\",\n\"zip\": \"84321\",\n\"state_name\": \"Utah\",\n\"assigned_to_id\": 265,\n\"assigned_to_name\": \"Bart Cage\",\n\"end_time\": null,\n\"start_time\": null,\n\"status_id\": 6,\n\"lat\": 41.7228185,\n\"lng\": -111.8397648,\n\"estimate_time\": \"00:15\",\n\"job_image\": null,\n\"image_for_client\": null,\n\"note\": null,\n\"note_for_client\": null,\n\"order\": 1,\n\"arrival\": 4,\n\"distance\": \"3.00\",\n\"skip_reason_title\": null,\n\"gate_code\": null,\n\"count_cross_sells\": 1,\n\"number_of_dogs\": null,\n\"safe_dogs\": null,\n\"gated_community\": null,\n\"commercial\": 1,\n\"work_areas\": null,\n\"commercial_client_id\": 76,\n\"commercial_location_id\": 127,\n\"start_lat\": null,\n\"start_lng\": null,\n\"start_distance\": null,\n\"clean_up_frequency\": null,\n\"end_lat\": null,\n\"end_lng\": null,\n\"end_distance\": null,\n\"skip_lat\": null,\n\"skip_lng\": null,\n\"skip_distance\": null,\n\"status_name\": \"dispatched\",\n\"duration\": \"-\",\n\"home_phone\": \"4155550110\",\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\",\n\"email\": \"demo@demo.com\"\n},\n{\n\"id\": 156890,\n\"client_location_id\": 2578,\n\"type\": \"custom\",\n\"organization_id\": 158,\n\"client_id\": 1567,\n\"full_name\": \"Carolina Wozniacki\",\n\"address\": \"149 W 300 N\",\n\"city\": \"Logan\",\n\"zip\": \"84321\",\n\"state_name\": \"Utah - UT\",\n\"assigned_to_id\": 246,\n\"assigned_to_name\": \"Ena Adamz\",\n\"end_time\": \"2022-03-29 08:24:07\",\n\"start_time\": \"2022-03-29 08:22:08\",\n\"status_id\": 2,\n\"lat\": 41.7374576,\n\"lng\": -111.8385534,\n\"estimate_time\": \"00:15\",\n\"job_image\": null,\n\"image_for_client\": null,\n\"note\": \"\",\n\"note_for_client\": \"\",\n\"order\": 5,\n\"arrival\": null,\n\"distance\": null,\n\"skip_reason_title\": null,\n\"gate_code\": null,\n\"count_cross_sells\": 0,\n\"number_of_dogs\": 1,\n\"safe_dogs\": \"\",\n\"gated_community\": null,\n\"commercial\": 0,\n\"work_areas\": null,\n\"commercial_client_id\": null,\n\"commercial_location_id\": null,\n\"start_lat\": null,\n\"start_lng\": null,\n\"start_distance\": null,\n\"clean_up_frequency\": \"bi_weekly\",\n\"end_lat\": null,\n\"end_lng\": null,\n\"end_distance\": null,\n\"skip_lat\": null,\n\"skip_lng\": null,\n\"skip_distance\": null,\n\"status_name\": \"completed\",\n\"duration\": \"00:21\",\n\"home_phone\": \"4155550110\",\n\"cell_phone\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"marketing_allowed_updated_at\": \"2025-03-05 10:20:55\",\n\"marketing_allowed_source\": \"open_api\",\n\"email\": \"demo@demo.com\"\n}\n]\n}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Access token checker",
            "description": "\nEndpoints for retrieving API access token details.",
            "item": [
                {
                    "name": "Show access token details",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/check_token",
                            "query": [
                                {
                                    "key": "token",
                                    "value": "vUcSxeEgTgg0I65bPEgKBqU0AjBRz8cy61843egzKkI3hAcYJ9ErNYe2MTEoIEWo",
                                    "description": "API access token - full string.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/check_token?token=vUcSxeEgTgg0I65bPEgKBqU0AjBRz8cy61843egzKkI3hAcYJ9ErNYe2MTEoIEWo"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"webhooks_url\": \"https:\/\/example.com\/webhooks\",\n\"enabled_events\": \"[\\\"lead:in_service_area\\\",\\\"lead:delete\\\",\\\"client:changed_status\\\"]\",\n\"_id\": 1\n}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Multi organization zip code check",
            "description": "\nEndpoints for checking which organization should serve a given ZIP code.",
            "item": [
                {
                    "name": "Find the nearest eligible organization for a ZIP code",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/check_zip_code_multi_organizations",
                            "query": [
                                {
                                    "key": "zip_code",
                                    "value": "12345",
                                    "description": "Client ZIP code. Must be a 5-digit number.",
                                    "disabled": false
                                },
                                {
                                    "key": "slugs[0]",
                                    "value": "similique",
                                    "description": "List of organization slugs to check.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/check_zip_code_multi_organizations?zip_code=12345&slugs[0]=similique"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the registration URL and the selected organization slug based on the provided ZIP code and a list of organization slugs.\nIf the ZIP code is not in any service area, the nearest organization is returned and `out_of_area` will be 1."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"url\": \"https:\/\/google.com\", \"slug\":\"ena-adamz-midmc\", \"out_of_area\":1}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Check whether an organization is premium",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/check_premium_organization",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/check_premium_organization"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Only premium organizations have access to the WordPress plugin."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"valid\": true, \"name\":\"Ena adamz\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Onboarding form",
            "description": "\nThe client onboarding workflow helps dog owners get a free quote and sign up for service on their own.\n\nEach account has its own unique and prebuilt client onboarding url which you may want to use as a reference. To obtain your url, please visit Employee portal > Settings > Client Onboarding > View in Browser then copy the url shown in the address bar. The form should look like this: https:\/\/client.sweepandgo.com\/unique-slug\/register",
            "item": [
                {
                    "name": "Get price, tax percent, cross sells, cross sells placement, custom price and more",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/price_registration_form",
                            "query": [
                                {
                                    "key": "last_time_yard_was_thoroughly_cleaned",
                                    "value": "one_week",
                                    "description": "When the yard was last thoroughly cleaned. Available options are: one_week, two_weeks, three_weeks, one_month, two_months, 3-4_months, 5-6_months, 7-9_months, 10+_months.",
                                    "disabled": false
                                },
                                {
                                    "key": "clean_up_frequency",
                                    "value": "once_a_week",
                                    "description": "Clean up frequency for the yard. Available options are: seven_times_a_week, six_times_a_week, five_times_a_week, four_times_a_week, three_times_a_week, two_times_a_week, once_a_week, bi_weekly, twice_per_month, every_three_weeks, every_four_weeks, once_a_month, one_time.",
                                    "disabled": false
                                },
                                {
                                    "key": "number_of_dogs",
                                    "value": "2",
                                    "description": "Number of dogs.",
                                    "disabled": false
                                },
                                {
                                    "key": "zip_code",
                                    "value": "12345",
                                    "description": "Zip code. Must be a 5-digit number.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/price_registration_form?last_time_yard_was_thoroughly_cleaned=one_week&clean_up_frequency=once_a_week&number_of_dogs=2&zip_code=12345"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "If the zip code is within the account service area, you may obtain price based on account (organization) slug, number of dogs, zip code, cleanup frequency and the last time the yard was cleaned.\n\nIf the initial and one time cleanup prices do not depend on the number of dogs and when the yard was cleaned last time, the account may set custom prices.\n\nThe regular price can be displayed per cleanup or as fixed price per default billing interval. To choose how to display your pricing on your client onboarding form go to Employee Portal > Settings > Billing > Onboarding Price display section > Edit > select price display option > Save.\n\nThe account special offers and important disclaimers may be highlighted within the price display. To update them go to Settings > Client Onboarding > Callouts & Disclaimers.\n\nIf the account offers additional services such as odor eliminator or kitty litter exchange you may also display those prices on the client onboarding form. To add additional services, go to Employee Portal > Settings > Additional Services > Add New."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"price\": {\n\"value\": \"85.00\",\n\"category\": \"prepaid\",\n\"billing_interval\": \"monthly\"\n},\n\"tax_percent\": \"10.250\",\n\"tax_percent_others\": 1,\n\"pricing_zip_code_type\": \"regular\",\n\"custom_price\": {\n\"short_description\": \"title\",\n\"long_description\": \"desc\"\n},\n\"show_price_options\": {\n\"show_per_cleanup\": 1,\n\"show_per_billing_interval\": 1,\n\"default_billing_interval\": \"monthly\"\n},\n\"cross_sells\": [\n{\n\"id\": 1,\n\"name\": \"Deodorizing\",\n\"description\": \"Eliminate poop and urine smell!\",\n\"unit\": \"Monthly Treatment (up to 1\\\/4 acre)\",\n\"unit_amount\": \"39.99\",\n\"taxable\": 1,\n\"service\": 1,\n\"tax_percent\": \"0.000\",\n\"count_clients\": 28\n},\n{\n\"id\": 2,\n\"name\": \"Kitty Litter Exchange\",\n\"description\": null,\n\"unit\": \"1\",\n\"unit_amount\": \"20.00\",\n\"taxable\": 0,\n\"service\": 0,\n\"tax_percent\": \"0.000\",\n\"count_clients\": 2\n},\n{\n\"id\": 3,\n\"name\": \"Dog Walking\",\n\"description\": null,\n\"unit\": \"15\",\n\"unit_amount\": \"30.00\",\n\"taxable\": 0,\n\"service\": 1,\n\"tax_percent\": \"0.000\",\n\"count_clients\": 1\n},\n{\n\"id\": 4,\n\"name\": \"Yard Size XL\",\n\"description\": \"3\\\/4 Acre Surcharge\",\n\"unit\": \"Monthly\",\n\"unit_amount\": \"30.00\",\n\"taxable\": 0,\n\"service\": 1,\n\"tax_percent\": \"0.000\",\n\"count_clients\": 0\n},\n{\n\"id\": 5,\n\"name\": \"Yard Size XXL\",\n\"description\": \"1 Acre Surcharge\",\n\"unit\": \"Monthly\",\n\"unit_amount\": \"40.00\",\n\"taxable\": 0,\n\"service\": 1,\n\"tax_percent\": \"0.000\",\n\"count_clients\": 0\n},\n{\n\"id\": 6,\n\"name\": \"Front Yard\",\n\"description\": null,\n\"unit\": \"Weekly\",\n\"unit_amount\": \"10.00\",\n\"taxable\": 0,\n\"service\": 1,\n\"tax_percent\": \"0.000\",\n\"count_clients\": 1\n},\n{\n\"id\": 7,\n\"name\": \"Front Yard\",\n\"description\": null,\n\"unit\": \"Monthly\",\n\"unit_amount\": \"40.00\",\n\"taxable\": 0,\n\"service\": 1,\n\"tax_percent\": \"0.000\",\n\"count_clients\": 0\n}\n],\n\"cross_sells_placement\": \"top\"\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get onboarding form fields, terms of use, callout and disclaimer and list of states",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/service_registration_form",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/service_registration_form"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "The length of the signup form and the fields to fill out depend on your signup form settings."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"form_fields\": [\n{\n\"value\": \"\",\n\"required\": false,\n\"step\": 2,\n\"frontend_name\": \"Coupon Code\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"coupon_code\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"1,2,3,4,5\",\n\"required\": true,\n\"step\": 2,\n\"frontend_name\": \"Number Of Dogs\",\n\"frontend_type\": \"select_single\",\n\"slug\": \"number_of_dogs\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"two_times_a_week,once_a_week,bi_weekly,once_a_month,one_time\",\n\"required\": true,\n\"step\": 2,\n\"frontend_name\": \"Cleanup Frequency\",\n\"frontend_type\": \"select_single\",\n\"slug\": \"clean_up_frequency\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"one_week,two_weeks,three_weeks,one_month,two_months,3-4_months,5-6_months,7-9_months,10+_months\",\n\"required\": true,\n\"step\": 2,\n\"frontend_name\": \"Last Time Yard Was Thoroughly Cleaned\",\n\"frontend_type\": \"select_single\",\n\"slug\": \"last_time_yard_was_thoroughly_cleaned\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"First Name\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"first_name\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Last Name\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"last_name\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Your Email Address\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"your_email_address\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Confirm Email Address\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"confirm_email_address\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": false,\n\"step\": 3,\n\"frontend_name\": \"Home Phone Number\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"home_phone_number\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Cell Phone Number\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"cell_phone_number\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Home Address\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"home_address\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"City\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"city\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"State\",\n\"frontend_type\": \"state\",\n\"slug\": \"state_province_region\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": false,\n\"step\": 3,\n\"frontend_name\": \"Dogs Name\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"dogs_name\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"yes,no\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Is it safe for us to be in the yard with your dog?\",\n\"frontend_type\": \"select_single\",\n\"slug\": \"safe_dog\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": false,\n\"step\": 3,\n\"frontend_name\": \"Breed\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"dogs_breeds\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": false,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": false,\n\"step\": 3,\n\"frontend_name\": \"Additional comment for dog\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"comments_for_each_dog\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"left,right,alley,no_gate,other\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Where is your gate located?\",\n\"frontend_type\": \"select_single\",\n\"slug\": \"gate_location\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Gated community\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"gated_community\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"Please insert the code if any\"\n},\n{\n\"value\": \"Back Yard,Flower Beds,Deck\\\/Patio,Dog Run,Garden,Side Yard (Left),Side Yard (Right),Area with Mulch,Area with Rocks\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Which areas should we clean?\",\n\"frontend_type\": \"select_multiple\",\n\"slug\": \"areas_to_clean\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"off_schedule,on_the_way,completed\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Cleanup Notifications\",\n\"frontend_type\": \"select_multiple\",\n\"slug\": \"cleanup_notification_type\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"What cleanup message would you like to receive?\"\n},\n{\n\"value\": \"email,sms,call\",\n\"required\": false,\n\"step\": 3,\n\"frontend_name\": \"Notification Type\",\n\"frontend_type\": \"select_single\",\n\"slug\": \"cleanup_notification_chanel\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"How would you like to receive cleanup notifications?\"\n},\n{\n\"value\": \"credit_card,check\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Please select your payment method\",\n\"frontend_type\": \"select_single\",\n\"slug\": \"payment_method\",\n\"organization_form_id\": 289,\n\"one_time\": false,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"search_engine,previous_client,referred_by_family_or_friend,directory_listing,social_media,vehicle_signage,radio_ad,local_event,gift_certificate,other\",\n\"required\": true,\n\"step\": 3,\n\"frontend_name\": \"Please tell us how you heard about us\",\n\"frontend_type\": \"select_single\",\n\"slug\": \"how_heard_about_us\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n},\n{\n\"value\": \"\",\n\"required\": false,\n\"step\": 3,\n\"frontend_name\": \"Additional comments\",\n\"frontend_type\": \"textfield\",\n\"slug\": \"additional_comment\",\n\"organization_form_id\": 289,\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"frontend_description\": \"\"\n}\n],\n\"terms_of_use\": {\n\"content\": \"<p>As the client, you are responsible for maintaining safe access into and out of the yard (if we are unable to clean due to access, you will be charged for that cleanup), immediate notification of any changes in the number of pets and prompt payment of balances due.<\\\/p><p><br><\\\/p><p>Inclement weather may make it hazardous or impossible to make a scheduled cleanup. In this event, we will be responsible for servicing your yard as soon as possible.<\\\/p><p><br><\\\/p><p>If for any reason your pet(s) will not be using the yard for a certain period (i.e. vacation, illness, etc.) and you do not wish to be charged for an unnecessary visit(s), please let us know in advance to pause the service. <\\\/p><p><br><\\\/p><p>We assume no liabilities for damages to yards, gates, pets or other properties.<\\\/p><p><br><\\\/p><p>Fees and Promotions are subject to change at any time. In this rare circumstance, you will be notified at least two (2) weeks prior to any changes.<\\\/p><p><br><\\\/p><p>Either party may terminate service (in writing) at any time. Unpaid balances are due within 15 days.<\\\/p><p><br><\\\/p><p>By initiating service, both parties agree to the above terms and responsibilities.<\\\/p>\"\n},\n\"callout_disclaimer\": {\n\"callout\": \"Our Best Rate! You and Your pet will love our service.\",\n\"disclaimer\": \"We do not offer refunds for missed cleanups due to holidays, snow days or thunderstorms - Displayed pricing is for an average backyard up to an 1\\\/8 of an acre - A valid credit card on file is required for recurring service.\"\n},\n\"states\": [\n{\n\"id\": 1,\n\"name\": \"Alabama - AL\"\n},\n{\n\"id\": 2,\n\"name\": \"Alaska - AK\"\n},\n{\n\"id\": 3,\n\"name\": \"Arizona - AZ\"\n},\n{\n\"id\": 4,\n\"name\": \"Arkansas - AR\"\n},\n{\n\"id\": 5,\n\"name\": \"California - CA\"\n},\n{\n\"id\": 6,\n\"name\": \"Colorado - CO\"\n},\n{\n\"id\": 7,\n\"name\": \"Connecticut - CT\"\n},\n{\n\"id\": 8,\n\"name\": \"Delaware - DE\"\n},\n{\n\"id\": 9,\n\"name\": \"District of Columbia - DC\"\n},\n{\n\"id\": 10,\n\"name\": \"Florida - FL\"\n},\n{\n\"id\": 11,\n\"name\": \"Georgia - GA\"\n},\n{\n\"id\": 12,\n\"name\": \"Hawaii - HI\"\n},\n{\n\"id\": 13,\n\"name\": \"Idaho - ID\"\n},\n{\n\"id\": 14,\n\"name\": \"Illinois - IL\"\n},\n{\n\"id\": 15,\n\"name\": \"Indiana - IN\"\n},\n{\n\"id\": 16,\n\"name\": \"Iowa - IA\"\n},\n{\n\"id\": 17,\n\"name\": \"Kansas - KS\"\n},\n{\n\"id\": 18,\n\"name\": \"Kentucky - KY\"\n},\n{\n\"id\": 19,\n\"name\": \"Louisiana - LA\"\n},\n{\n\"id\": 20,\n\"name\": \"Maine - ME\"\n},\n{\n\"id\": 33,\n\"name\": \"Maryland - MD\"\n},\n{\n\"id\": 34,\n\"name\": \"Massachusetts - MA\"\n},\n{\n\"id\": 35,\n\"name\": \"Michigan - MI\"\n},\n{\n\"id\": 36,\n\"name\": \"Minnesota - MN\"\n},\n{\n\"id\": 37,\n\"name\": \"Mississippi - MS\"\n},\n{\n\"id\": 38,\n\"name\": \"Missouri - MO\"\n},\n{\n\"id\": 21,\n\"name\": \"Montana - MT\"\n},\n{\n\"id\": 22,\n\"name\": \"Nebraska - NE\"\n},\n{\n\"id\": 23,\n\"name\": \"Nevada - NV\"\n},\n{\n\"id\": 24,\n\"name\": \"New Hampshire - NH\"\n},\n{\n\"id\": 25,\n\"name\": \"New Jersey - NJ\"\n},\n{\n\"id\": 26,\n\"name\": \"New Mexico - NM\"\n},\n{\n\"id\": 27,\n\"name\": \"New York - NY\"\n},\n{\n\"id\": 28,\n\"name\": \"North Carolina - NC\"\n},\n{\n\"id\": 29,\n\"name\": \"North Dakota - ND\"\n},\n{\n\"id\": 30,\n\"name\": \"Ohio - OH\"\n},\n{\n\"id\": 31,\n\"name\": \"Oklahoma - OK\"\n},\n{\n\"id\": 32,\n\"name\": \"Oregon - OR\"\n},\n{\n\"id\": 39,\n\"name\": \"Pennsylvania - PA\"\n},\n{\n\"id\": 40,\n\"name\": \"Rhode Island - RI\"\n},\n{\n\"id\": 41,\n\"name\": \"South Carolina - SC\"\n},\n{\n\"id\": 42,\n\"name\": \"South Dakota - SD\"\n},\n{\n\"id\": 43,\n\"name\": \"Tennessee - TN\"\n},\n{\n\"id\": 44,\n\"name\": \"Texas - TX\"\n},\n{\n\"id\": 45,\n\"name\": \"Utah - UT\"\n},\n{\n\"id\": 46,\n\"name\": \"Vermont - VT\"\n},\n{\n\"id\": 47,\n\"name\": \"Virginia - VA\"\n},\n{\n\"id\": 48,\n\"name\": \"Washington - WA\"\n},\n{\n\"id\": 49,\n\"name\": \"West Virginia - WV\"\n},\n{\n\"id\": 50,\n\"name\": \"Wisconsin - WI\"\n},\n{\n\"id\": 51,\n\"name\": \"Wyoming - WY\"\n}\n]\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get organization branding info",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/organization_data",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/organization_data"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"organization\":\n{\"analytic_enabled\":1,\n\"branding_color\":\"#39A597\",\n\"business_address\":\"1502 Morse St\",\n\"business_city\":\"Houston\",\n\"business_lat\":\"29.7521804\",\n\"business_lng\":\"-95.4058215\",\n\"business_name\":\"Magnificent Scoopers 777\",\n\"business_phone\":\"2025550101\",\n\"business_state\":\"Texas\",\n\"business_website\":\"https:\/\/www.sweepandgo.com\/\",\n\"business_zip\":\"77019\",\n\"can_call_company_phone_client_portal\":\"1\",\n\"can_text_company_phone_client_portal\":\"1\",\n\"card_connect_site\":null,\n\"charges_enabled\":1,\n\"commercial_inventory_tracking\":\"0\",\n\"ga_tracking_id\":\"null\",\n\"logo\":\"\",\n\"organization\":\"magnificent-scoopers-777-p4ycx\",\n\"organization_can_have_onboarding\":true,\n\"organization_id\":161,\n\"organization_name\":\"Magnificent Scoopers 777\",\n\"organization_status\":\"active\",\n\"pay_period\":\"monthly\",\n\"payroll_filter\":\"years_in_service,revenue,revenue_adjustment,distance,overtime_hours,vacation_hours,tips,reimbursement,deduction,number_of_jobs,number_of_complaints,mileage_rate,base_percentage,fixed_rate\",\n\"rating_tipping\":\"enabled_all\",\n\"send_invoice_email\":\"1\",\n\"show_company_address_client_portal\":\"1\",\n\"show_company_email_client_portal\":\"1\",\n\"show_company_phone_client_portal\":\"1\",\n\"show_logo_onboarding\":\"1\",\n\"show_name_onboarding\":\"0\",\n\"show_on_list\":\"0\",\n\"show_payroll_filed_tech\":\"1\",\n\"show_rating_comment_fieldtech\":\"1\",\n\"subscription_package\":\"Professional\",\n\"website\":\"http:\/\/www.superskooopers.com\"}}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get default onboarding coupon if exists",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/coupon_find_default",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/coupon_find_default"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{ \"coupon\": {\n\"coupon_id\": \"50POFF\",\n\"coupon_name\":\"Spring Season\",\n\"percent_off\": \"20\",\n\"amount_off\": null,\n\"duration_in_months\": 0,\n\"duration\": \"once\"\n}\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Check coupon code valid",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/coupon_find",
                            "query": [
                                {
                                    "key": "coupon_id",
                                    "value": "5pr1nG",
                                    "description": "Coupon code.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/coupon_find?coupon_id=5pr1nG"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "If the account runs any special promos, new clients may enter a coupon code. To create promos and coupon codes, go to Employee Portal > Billing > Coupons > New."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"coupon\": {\n\"percent_off\": \"25.00\",\n\"amount_off\": null,\n\"duration_in_months\": 3,\n\"duration\": \"repeating\",\n\"coupon_id\": \"5pr1nG\",\n\"coupon_name\": \"Spring Sale NEW\"\n}\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Check client email exists",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/check_client_email_exists",
                            "query": [
                                {
                                    "key": "email",
                                    "value": "john%40doe.com",
                                    "description": "Client email address.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/check_client_email_exists?email=john%40doe.com"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Checks whether a client with the given email already exists as an active client within the organization."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{ \"exists\": true }",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get thank you messages to show up on complete onboarding client",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/thank_you_pages",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/thank_you_pages"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"thank_you_pages\":[{\"type\":\"credit_card_sign_up\",\"content\":\"<p>Thank You For Signing Up<\\\/p><br><p>We have just sent you an email confirmation and login information to our client portal. We will also contact you to confirm your information and schedule a start date!<\\\/p><br>Payment Details:<ul><li>You have enrolled in our subscription payment option.<\\\/li><li>By far, the easiest way to pay for services<\\\/li><li>Your card will be charged after the completion the initial cleanup.<\\\/li><li>We will send you invoices according to your billing option and billing cycle and your card will be auto-debited according to NET terms on your account.<\\\/li><\\\/ul><br><p>If at any time, you have questions about your service or would like to change your card information or cancel monthly service, please contact us via client portal, email or phone.<\\\/p><br><p>Thank you.<\\\/p>\"},{\"type\":\"check_payment_sign_up\",\"content\":\"<p>Thank You for Signing Up<\\\/p><br><p>We have just sent you an email confirmation and login information to our client portal. We will also contact you to confirm your information and schedule a start date!<\\\/p><br>Payment Details:<ul><li>You have chosen to pay by check for your services.<\\\/li><li>Payment is required for the initial cleanup on completion. Your technician can collect a check at time of cleanup. If you will not be home, please leave a check for the larger amount of the Estimated Initial Cleanup (please see your confirmation email for estimate).<\\\/li><li>For regular services, we will email your recurring invoices according to your billing option and cycle, payment is due according to NET terms on your account.<\\\/li><li>If you would like to switch to auto pay, please just enter you credit card details within your client portal. <\\\/li><\\\/ul><br><p>If at any time, you have questions about your service, please contact us via email or phone.<\\\/p><br><p>Thank you.<\\\/p>\"},{\"type\":\"one_time_clean_up\",\"content\":\"<p>Thank you for Requesting a One Time Cleanup<\\\/p><br><p>We have just sent you an email confirmation and login information to our client portal. We will also contact you to confirm your information and schedule your cleanup.<\\\/p><br><p>Thank you.<\\\/p>\"}]}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get out of area form fields",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/out_of_service_form",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/out_of_service_form"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "If the zip code is not within your service area, your prospect will be asked to fill out a short form so you could research more.\nAfter the form is submitted,  the account will receive an email with lead information."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"form_fields\": [\n{\n\"id\": 4658,\n\"organization_form_id\": 290,\n\"frontend_type\": \"textfield\",\n\"frontend_description\": \"\",\n\"backend_description\": \"\",\n\"slug\": \"zip_code\",\n\"step\": 3,\n\"frontend_name\": \"Zip code\",\n\"backend_name\": \"Zip code\",\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"required\": true,\n\"optional_show\": true,\n\"optional_required\": false,\n\"backend_type\": \"textfield\",\n\"value\": \"\",\n\"options\": \"\",\n\"locked\": false,\n\"backend_sort\": 27,\n\"frontend_sort\": 27,\n\"locked_options\": false,\n\"hint\": \"\"\n},\n{\n\"id\": 4659,\n\"organization_form_id\": 290,\n\"frontend_type\": \"textfield\",\n\"frontend_description\": \"\",\n\"backend_description\": \"\",\n\"slug\": \"name\",\n\"step\": 3,\n\"frontend_name\": \"Name\",\n\"backend_name\": \"Name\",\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"required\": true,\n\"optional_show\": true,\n\"optional_required\": false,\n\"backend_type\": \"textfield\",\n\"value\": \"\",\n\"options\": \"\",\n\"locked\": false,\n\"backend_sort\": 28,\n\"frontend_sort\": 28,\n\"locked_options\": false,\n\"hint\": \"\"\n},\n{\n\"id\": 4660,\n\"organization_form_id\": 290,\n\"frontend_type\": \"textfield\",\n\"frontend_description\": \"\",\n\"backend_description\": \"\",\n\"slug\": \"email_address\",\n\"step\": 3,\n\"frontend_name\": \"Email address\",\n\"backend_name\": \"Email address\",\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"required\": true,\n\"optional_show\": true,\n\"optional_required\": false,\n\"backend_type\": \"textfield\",\n\"value\": \"\",\n\"options\": \"\",\n\"locked\": false,\n\"backend_sort\": 29,\n\"frontend_sort\": 29,\n\"locked_options\": false,\n\"hint\": \"\"\n},\n{\n\"id\": 4662,\n\"organization_form_id\": 290,\n\"frontend_type\": \"textfield\",\n\"frontend_description\": \"\",\n\"backend_description\": \"\",\n\"slug\": \"phone\",\n\"step\": 3,\n\"frontend_name\": \"Phone number\",\n\"backend_name\": \"Phone number\",\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"required\": false,\n\"optional_show\": true,\n\"optional_required\": false,\n\"backend_type\": \"textfield\",\n\"value\": \"\",\n\"options\": \"\",\n\"locked\": false,\n\"backend_sort\": 30,\n\"frontend_sort\": 30,\n\"locked_options\": false,\n\"hint\": \"\"\n},\n{\n\"id\": 4661,\n\"organization_form_id\": 290,\n\"frontend_type\": \"textfield\",\n\"frontend_description\": \"\",\n\"backend_description\": \"\",\n\"slug\": \"address\",\n\"step\": 3,\n\"frontend_name\": \"Address\",\n\"backend_name\": \"Address\",\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"required\": true,\n\"optional_show\": true,\n\"optional_required\": false,\n\"backend_type\": \"textfield\",\n\"value\": \"\",\n\"options\": \"\",\n\"locked\": false,\n\"backend_sort\": 31,\n\"frontend_sort\": 31,\n\"locked_options\": false,\n\"hint\": \"\"\n},\n{\n\"id\": 4663,\n\"organization_form_id\": 290,\n\"frontend_type\": \"textfield\",\n\"frontend_description\": \"\",\n\"backend_description\": \"\",\n\"slug\": \"comment\",\n\"step\": 3,\n\"frontend_name\": \"Comment\",\n\"backend_name\": \"Comment\",\n\"one_time\": true,\n\"recurring\": true,\n\"show\": true,\n\"required\": false,\n\"optional_show\": true,\n\"optional_required\": false,\n\"backend_type\": \"textfield\",\n\"value\": \"\",\n\"options\": \"\",\n\"locked\": false,\n\"backend_sort\": 32,\n\"frontend_sort\": 32,\n\"locked_options\": false,\n\"hint\": \"\"\n}\n]\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Save out of service area lead",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/out_of_service_form",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/out_of_service_form"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"name\":\"Ena Doe\",\"address\":\"1502 Morse St\",\"email_address\":\"ena@doe.com\",\"zip_code\":\"12345\",\"comment\":\"Demo comment\",\"phone\":\"2025550101\",\"marketing_allowed\":1,\"marketing_allowed_source\":\"open_api\"}"
                        },
                        "description": "Sends an email for leads that are outside the service area."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\": \"success\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Check zip code exists in your account",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/check_zip_code_exists",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/check_zip_code_exists"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"value\":\"12345\"}"
                        },
                        "description": "To get started you may want to validate that the client zip code exists in your account or accounts."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"exists\": \"not_exists\"}",
                            "name": ""
                        },
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"exists\": \"exists\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Create client with package subscription",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/client_on_boarding\/create_client_with_package",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/client_on_boarding\/create_client_with_package"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"email\":\"john@doe.com\",\"first_name\":\"John\",\"last_name\":\"Doe\",\"home_phone_number\":\"4155550110\",\"cell_phone_number\":\"2025550101\",\"home_address\":\"1502 Morse St\",\"city\":\"New York\",\"state\":\"TX\",\"zip_code\":\"12345\",\"clean_up_frequency\":\"once_a_week\",\"cross_sell_id\":\"2\",\"category\":\"cleanup\",\"billing_interval\":\"monthly\",\"credit_card_token\":\"tok_5678967890678 or 678987678909876\",\"name_on_card\":\"John Doe\",\"marketing_allowed\":1,\"marketing_allowed_source\":\"open_api\",\"coupon_code\":\"5pr1nG\",\"terms_open_api\":1,\"cross_sells_names\":\"Awesome package\"}"
                        },
                        "description": "Create client with selected package."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\": \"success\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "One time invoice charge using credit cards",
            "description": "\nEndpoints for processing one-time invoice payments.",
            "item": [
                {
                    "name": "Check invoice status",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/one_time_payment\/check_invoice",
                            "query": [
                                {
                                    "key": "invoice_number",
                                    "value": "3-3-190207-2-4",
                                    "description": "Invoice number.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/one_time_payment\/check_invoice?invoice_number=3-3-190207-2-4"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the remaining invoice balance and the payment gateway (if applicable)."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"invoice_remaining\": \"12.23\", \"payment_gateway\":\"fts\/stripe\/none\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "One time payment using Stripe",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/one_time_payment\/stripe_payment",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/one_time_payment\/stripe_payment"
                        },
                        "method": "PUT",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"invoice_number\":\"3-3-190207-2-4\",\"amount\":\"67.98\",\"name_on_card\":\"John Doe\",\"token\":\"tok_1E0rfhHLLICwofnx4bUzDZis\"}"
                        },
                        "description": "Charges the invoice using Stripe and marks it as paid when successful."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"status\": \"paid\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "One time check payments",
            "description": "\nEndpoints for one time check payments.",
            "item": [
                {
                    "name": "One time check payment",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/invoice\/one_time",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/invoice\/one_time"
                        },
                        "method": "PUT",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"invoice_number\":\"3-3-190207-2-4\",\"reference_number\":\"ref_8798yhjasa\",\"amount\":\"67.98\",\"status\":\"successful\",\"billing_address\":\"635 Go Man Go Dr\",\"billing_city\":\"Stafford\",\"billing_state\":\"Texas\",\"billing_zip\":\"77477\",\"name\":\"John Doe\",\"email\":\"mail@mail.com\"}"
                        },
                        "description": "Records one time check payment for a residential client."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\": \"success\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Reports",
            "description": "\nEndpoints for retrieving report counts and staff lists.",
            "item": [
                {
                    "name": "Count dogs for happy clients",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/report\/count_happy_dogs",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/report\/count_happy_dogs"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the total number of dogs across all happy clients."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"data\":23}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Count happy clients",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/report\/count_happy_clients",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/report\/count_happy_clients"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the total number of happy clients."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"data\":23}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Count active clients",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/report\/count_active_clients",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/report\/count_active_clients"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the total number of active clients."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"data\":23}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Count completed jobs",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/report\/jobs_count",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/report\/jobs_count"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns the total number of completed jobs."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"data\":23}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "List of active staff",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/report\/staff_select_list",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/report\/staff_select_list"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a list of active staff members for the organization."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n   \"data\": [\n     {\n       \"id\": 1,\n       \"name\": \"John Doe\",\n       \"email\": \"john@doe.com\",\n       \"color\": \"#87332\",\n       \"phone\": \"2025550101\",\n       \"status\": \"active\"\n     },\n     {\n       \"id\": 2,\n       \"name\": \"Jane Doe\",\n       \"email\": \"jane@doe.com\",\n       \"color\": \"#3355AA\",\n       \"phone\": \"2025550102\",\n       \"status\": \"active\"\n     }\n   ]\n }",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Completed jobs report",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/report\/completed_jobs_report",
                            "query": [
                                {
                                    "key": "date",
                                    "value": "2026-07-13",
                                    "description": "Filter jobs for a specific date. Must be today or in the past. Format: YYYY-MM-DD.",
                                    "disabled": false
                                },
                                {
                                    "key": "date_from",
                                    "value": "2026-01-01",
                                    "description": "Start date for the report. Required when date is not provided. Must be today or in the past. Format: YYYY-MM-DD.",
                                    "disabled": false
                                },
                                {
                                    "key": "date_to",
                                    "value": "2026-01-31",
                                    "description": "End date for the report. Required when date is not provided. Must be on or after date_from and cannot be in the future. Format: YYYY-MM-DD.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/report\/completed_jobs_report?date=2026-07-13&date_from=2026-01-01&date_to=2026-01-31"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a detailed report of completed jobs for a specific date or date range.\n\nProvide either `date` for a single-day report or both `date_from` and `date_to` for a date-range report.\nAll dates must be today or in the past.\n\nPossible job status values:\n- pending (1)\n- completed (2)\n- skipped (3)\n- missed (4)\n- started (5)\n- dispatched (6)\n\nPossible job types:\n- custom\n- initial\n- one_time\n- reclean\n- recurring"
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"job_list\": [\n{\n\"commercial_name\": null,\n\"type\": \"custom\",\n\"quantity\": 1,\n\"first_name\": \"Pete\",\n\"last_name\": \"Peterson\",\n\"assigned_to_name\": \"John Doe\",\n\"assigned_to_id\": 509,\n\"status_id\": 2,\n\"start_time\": \"2026-07-13 04:30:59\",\n\"end_time\": \"2026-07-13 04:40:25\",\n\"pricing_plan_name\": \"Regular Plan\",\n\"service_plan_name\": \"1d-1xW\",\n\"service_plan_slug\": \"once_a_week\",\n\"date\": \"2026-07-13\",\n\"note\": null,\n\"skip_reason_title\": null,\n\"count_cross_sells\": 0,\n\"price\": \"25.00\",\n\"additional_services\": null,\n\"status_name\": \"completed\",\n\"duration\": \"9:26\",\n\"service_label\": null\n}\n]\n}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Gift card certificates",
            "description": "\nEndpoints for managing gift card certificates.",
            "item": [
                {
                    "name": "Send new Gift card certificate",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/gift_card",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/gift_card"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"purchaser_name\":\"John Doe\",\"purchaser_email\":\"jon@doe.com\",\"purchaser_phone\":\"2025550101\",\"amount\":\"12.45\",\"expires\":\"2024-12-23\",\"bought\":\"2024-11-23\",\"reference_number\":\"12c45-wa3B\",\"recipient_name\":\"Jane Doe\",\"recipient_email\":\"jane@doe.com\",\"special_note\":\"For your birthday\"}"
                        },
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\": \"success\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Coupons",
            "description": "\nEndpoints for managing coupons for residential subscriptions.",
            "item": [
                {
                    "name": "Create coupon for residential subscriptions",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/coupon",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/coupon"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"coupon_id\":\"5pr1nG\",\"name\":\"Spring Season\",\"coupon_type\":\"amount\",\"duration\":\"repeating\",\"percent_off\":\"20\",\"amount_off\":\"22.51\",\"redeem_by\":\"2024-12-23\",\"max_redemptions\":5,\"number_of_months\":2}"
                        },
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\": \"success\", \"coupon\": {\n                                        \"coupon_id\": \"5pr1nG\",\n                                        \"name\": \"Spring Season\"\n                                    }}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Free quotes",
            "description": "\nEndpoints for retrieving free quotes.",
            "item": [
                {
                    "name": "Get free quotes",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/free_quotes",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/free_quotes"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a list of free quotes."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"free_quotes\": [\n{\n\"coupon_code\": \"UKdJ5C0W\",\n\"number_of_dogs\": \"4\",\n\"clean_up_frequency\": \"five_times_a_week\",\n\"last_time_yard_was_thoroughly_cleaned\": \"two_months\",\n\"your_email_address\": \"client@example.com\",\n\"cell_phone_number\": \"2025550101\",\n\"marketing_allowed\": 1,\n\"first_name\": \"Ena\",\n\"last_name\": \"Doe\",\n\"created_at\": \"2026-02-15 10:42:31\"\n}\n]\n}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Inbound SMS notifications",
            "description": "",
            "item": [
                {
                    "name": "Dog secured confirmation request",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/text-inbound\/on-the-way\/check-dogs",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/text-inbound\/on-the-way\/check-dogs"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"From\":\"12025550102\",\"To\":\"12025550101\",\"SmsMessageSid\":\"89iwieweow8e49038408902\",\"Body\":\"ENT\"}"
                        },
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\": \"success\"}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Twilio webhook",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/text-twilio\/on-the-way\/webhook",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/text-twilio\/on-the-way\/webhook"
                        },
                        "method": "POST",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"status\":\"delivered\",\"job_id\":\"123\",\"client\":\"cus_9is0ia893\",\"chanel\":\"sms\",\"type\":\"on_the_way\",\"staff_id\":1,\"local_message_id\":\"270444-10-1753266841837\",\"message_id\":\"SM4a13b79c2b6a0e17bb77b6c0ce0d4a34\",\"error_code\":1}"
                        },
                        "description": "Notify field tech that a client has received notification."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\"success\": \"success\"}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Packaged cross-sells",
            "description": "\nEndpoints for retrieving packaged cross-sells.",
            "item": [
                {
                    "name": "Get packaged cross-sells",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/packages_list",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v2\/packages_list"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a list of packaged cross-sells for a given organization."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n  \"cross_sells\": [\n    {\n      \"id\": 201,\n      \"name\": \"Starter Package\",\n      \"description\": \"Essential tools to get started with our service.\",\n      \"unit\": \"bundle\",\n      \"unit_amount\": \"20.00\",\n      \"taxable\": 1,\n      \"service\": 0,\n      \"tax_percent\": \"5.000\",\n      \"package\": 1,\n      \"package_order\": 1,\n      \"featured\": 1,\n      \"featured_label\": \"Most Popular\",\n      \"descriptions\": \"Includes basic deodorizer, gloves, and poop bags.\",\n      \"button_color\": \"#4CAF50\",\n      \"background_color\": \"#E8F5E9\",\n      \"featured_color\": \"#FFC107\",\n      \"cleanup_frequency\": \"weekly\",\n      \"count_clients\": 110\n    },\n    {\n      \"id\": 202,\n      \"name\": \"Premium Package\",\n      \"description\": \"Full service kit with advanced cleaning solutions.\",\n      \"unit\": \"box\",\n      \"unit_amount\": \"40.00\",\n      \"taxable\": 1,\n      \"service\": 0,\n      \"tax_percent\": \"5.000\",\n      \"package\": 1,\n      \"package_order\": 2,\n      \"featured\": 0,\n      \"featured_label\": null,\n      \"descriptions\": \"Includes premium scented sprays, large bags, and protective wear.\",\n      \"button_color\": \"#2196F3\",\n      \"background_color\": \"#E3F2FD\",\n      \"featured_color\": null,\n      \"cleanup_frequency\": \"bi-weekly\",\n      \"count_clients\": 65\n    }\n  ],\n  \"cross_sells_placement\": \"top\",\n  \"billing_interval\": \"monthly\",\n  \"category\": \"cleanup\"\n}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Webhooks",
            "description": "\nWebhooks for organization. Here is the list of all webhooks for one organization. You may trigger it at any time to receive a list of all webhook types.\nType list of webhooks:\n- free:quote - Free quote\n- lead:out_of_service_area - Lead - out of service area\n- lead:in_service_area - Lead - in service area\n- lead:delete - Lead - deleted\n- client:changed_status - Client - changed status\n- client:changed_info - Client - changed info\n- client:changed_address - Client - changed address\n- client:client_onboarding_recurring - Client - client onboarding recurring\n- client:client_onboarding_onetime - Client - client onboarding onetime\n- client:subscription_created - Client - subscription created\n- client:subscription_canceled - Client - subscription canceled\n- client:subscription_paused - Client - subscription paused\n- client:subscription_unpaused - Client - subscription unpaused\n- client:invoice_finalized - Client - invoice finalized\n- client:client_payment_declined - Client payment was declined\n- client:client_payment_accepted - Client payment was accepted\n- notification:on_the_way_notification - Notification - on the way notification\n- notification:off_schedule_notification - Notification - off schedule notification\n- notification:completed_job_notification - Notification - completed job notification\n- notification:skipped_job_notification - Notification - skipped job notification\n- notification:client_not_assigned - Notification - client not assigned\n- client:client_assigned - Client - client assigned\n- client:subscription_cancel_requested - Client - subscription cancel requested\n- client:notification_settings_changed - Client - notification settings changed\n- client:additional_contact_changed - Client - additional contact changed\n- client:reviews_automation - Client - reviews automation\n- client:areas_to_clean_changed - Client - areas to clean changed\n- staff:staff_clock_in - Staff - staff clock in\n- staff:staff_forgot_to_clock_out - Staff - staff forgot to clock out\n- staff:shift_break_started - Staff - shift break started\n- staff:shift_break_info - Staff - shift break info\n- job:started - Job - started with info\n- job:completed - Job - completed with info start time, end time, job type and price\n- organization:client_onboarding_form_changed - Business - client onboarding form changed\n- organization:cross_sells_changed - Business - cross sells changed\n- payroll:shift_info - Payroll - shift info, work time, start time, end time, mileages, duration, break duration\n- payroll:tip_info - Payroll - tip linked to invoice with amount\n- dog:birthday - Send webhook on dog birthday 7 days in advance\n- client:credit_card_link_created - Private credit card link created for add new credit card",
            "item": [
                {
                    "name": "List of all possible webhooks",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/webhooks\/index",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/webhooks\/index"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "",
                        "auth": {
                            "type": "noauth"
                        }
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 403,
                            "body": "{\"errors\":[\"Authorization failed\"]}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "List of all webhooks for one organization which are previously triggered",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/webhooks\/list",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "2",
                                    "description": "Get results for specific page.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v1\/webhooks\/list?page=2"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 403,
                            "body": "{\"errors\":[\"API key is not valid\"]}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Retry one webhook",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v1\/webhooks\/retry",
                            "query": [],
                            "raw": "{{baseUrl}}\/api\/v1\/webhooks\/retry"
                        },
                        "method": "PUT",
                        "header": [
                            {
                                "key": "Content-Type",
                                "value": "application\/json"
                            },
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": {
                            "mode": "raw",
                            "raw": "{\"id\":\"e0e03073-a1a3-4f6e-82ff-81dab3772534\"}"
                        },
                        "description": ""
                    },
                    "response": [
                        {
                            "header": [
                                {
                                    "key": "cache-control",
                                    "value": "no-cache, private"
                                },
                                {
                                    "key": "content-type",
                                    "value": "application\/json"
                                },
                                {
                                    "key": "access-control-allow-origin",
                                    "value": "*"
                                }
                            ],
                            "code": 403,
                            "body": "{\"errors\":[\"API key is not valid\"]}",
                            "name": ""
                        }
                    ]
                }
            ]
        },
        {
            "name": "Billing Info",
            "description": "\nEndpoints for retrieving billing info - recurring and one-time invoices and payments.",
            "item": [
                {
                    "name": "Get invoices",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/invoices",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "1",
                                    "description": "Page number. Must be at least 1.",
                                    "disabled": false
                                },
                                {
                                    "key": "type",
                                    "value": "recurring",
                                    "description": "Type of invoices to return. Available options: recurring, one_time.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/invoices?page=1&type=recurring"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a paginated list of invoices.\n\nUse `recurring` type to return subscription invoices, or `one_time` to return all one-time invoices.\n\nDraft and voided invoices are excluded.\n\nPossible returned invoice types are: initial, one_time, prorated, subscription and variable.\n\nPossible billing intervals are: annually, semi-annually, every_four_months, quarterly, every_two_months, monthly, 4_weeks, bi-weekly, weekly, daily, initial, one_time and prorated.\n\nPossible categories are: postpaid, prepaid, cleanup and variable."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"invoices\": {\n\"current_page\": 1,\n\"data\": [\n{\n\"created_at\": \"2026-07-02 00:03:23\",\n\"tip_amount\": \"0.00\",\n\"next_try_charging\": null,\n\"commercial_client\": \"Test Business\",\n\"commercial_location\": \"Location 1\",\n\"invoice_number\": \"323-270-260702-8-62215\",\n\"client_name\": \"Test Business\",\n\"pay_method\": \"check\",\n\"status\": \"paid\",\n\"total\": \"12.00\",\n\"type\": \"subscription\",\n\"remaining\": \"0.00\",\n\"category\": \"postpaid\",\n\"billing_interval\": \"weekly\",\n\"refunded\": \"0.00\",\n\"paid\": \"12.00\",\n\"period_end\": \"2026-07-09 00:03:23\",\n\"period_start\": \"2026-07-02 00:03:23\"\n},\n{\n\"created_at\": \"2026-07-14 05:03:02\",\n\"tip_amount\": \"0.00\",\n\"next_try_charging\": null,\n\"commercial_client\": null,\n\"commercial_location\": null,\n\"invoice_number\": \"127-1104-200521-2-5830\",\n\"client_name\": \"Frankie Hooper\",\n\"pay_method\": \"credit_card\",\n\"status\": \"paid\",\n\"total\": \"52.67\",\n\"type\": \"subscription\",\n\"remaining\": \"0.00\",\n\"category\": \"prepaid\",\n\"billing_interval\": \"daily\",\n\"refunded\": \"0.00\",\n\"paid\": \"52.67\",\n\"period_end\": \"2026-07-15 05:03:02\",\n\"period_start\": \"2026-07-14 05:03:02\"\n}\n],\n\"per_page\": 10,\n\"from\": 1,\n\"to\": 10,\n\"total\": 31,\n\"last_page\": 4,\n\"next_page_url\": \"https:\/\/api.example.com\/api\/invoices\/recurring?page=2\",\n\"prev_page_url\": null\n}\n}",
                            "name": ""
                        }
                    ]
                },
                {
                    "name": "Get payments",
                    "request": {
                        "url": {
                            "host": "{{baseUrl}}",
                            "path": "api\/v2\/payments",
                            "query": [
                                {
                                    "key": "page",
                                    "value": "1",
                                    "description": "Page number. Must be at least 1. Defaults to 1.",
                                    "disabled": false
                                }
                            ],
                            "raw": "{{baseUrl}}\/api\/v2\/payments?page=1"
                        },
                        "method": "GET",
                        "header": [
                            {
                                "key": "Accept",
                                "value": "application\/json"
                            }
                        ],
                        "body": null,
                        "description": "Returns a paginated list of payments."
                    },
                    "response": [
                        {
                            "header": [],
                            "code": 200,
                            "body": "{\n\"payments\": {\n\"current_page\": 1,\n\"data\": [\n{\n\"date\": \"2026-07-06\",\n\"amount\": 22,\n\"amount_refunded\": \"0.00\",\n\"status\": \"succeeded\",\n\"type\": \"credit_card\",\n\"description\": \"Payment for invoice 127-1060-200318-2-4420\",\n\"client_name\": \"John Doe\",\n\"tip_amount\": \"0.00\",\n\"commercial_location\": null,\n\"commercial_client\": null\n}\n],\n\"per_page\": 10,\n\"from\": 1,\n\"to\": 10,\n\"total\": 300,\n\"last_page\": 30,\n\"next_page_url\": \"https:\/\/api.example.com\/api\/payments?page=2\",\n\"prev_page_url\": null\n}\n}",
                            "name": ""
                        }
                    ]
                }
            ]
        }
    ],
    "auth": {
        "type": "bearer",
        "bearer": [
            {
                "key": "key",
                "type": "string"
            }
        ]
    }
}