Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/token_generate/access_tokens?organization_id=2"

const url = new URL(
    "https://openapi.sweepandgo.com/api/token_generate/access_tokens"
);

const params = {
    "organization_id": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));



fetch(url, {
    method: "GET",
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/token_generate/access_tokens';
$response = $client->get(
    $url,
    [
        'query' => [
            'organization_id' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/token_generate/access_tokens'
params = {
  'organization_id': '2',
}
response = requests.request('GET', url, params=params)
response.json()

Example response (200):

[
    {
        "data": [
            {
                "id": 12,
                "token": "************************************************************XLtm",
                "webhooks_url": "https://example.com/webhooks",
                "description": "First token",
                "enabled_events": [
                    "client:client_onboarding_onetime",
                    "client:client_recurring_employee_portal"
                ]
            },
            {
                "id": 18,
                "token": "************************************************************9P4a",
                "webhooks_url": "https://example.com/webhooks",
                "description": "Second token",
                "enabled_events": [
                    "client:client_onboarding_onetime"
                ]
            }
        ],
        "webhooks": {
            "free:quote": "Free quote",
            "lead:out_of_service_area": "Lead - out of service area",
            "lead:in_service_area": "Lead - in service area",
            "lead:delete": "Lead - deleted",
            "client:changed_status": "Client - changed status",
            "client:changed_info": "Client - changed info",
            "client:changed_address": "Client - changed address",
            "client:client_onboarding_recurring": "Client - client onboarding recurring",
            "client:client_onboarding_onetime": "Client - client onboarding onetime",
            "client:subscription_created": "Client - subscription created",
            "client:subscription_canceled": "Client - subscription canceled",
            "client:subscription_paused": "Client - subscription paused",
            "client:subscription_unpaused": "Client - subscription unpaused",
            "client:invoice_finalized": "Client - invoice finalized",
            "client:client_no_assigned": "Client - client no assigned",
            "client:client_assigned": "Client - client assigned",
            "client:subscription_cancel_requested": "Client - subscription cancel requested",
            "client:notification_settings_changed": "Client - notification settings changed",
            "client:additional_contact_changed": "Client - additional contact changed",
            "client:client_payment_declined": "Client - client payment declined",
            "client:client_payment_accepted": "Client - client payment accepted",
            "client:reviews_automation": "Client - reviews automation",
            "client:areas_to_clean_changed": "Client - areas to clean changed",
            "notification:on_the_way_notification": "Notification - on the way notification",
            "notification:off_schedule_notification": "Notification - off schedule notification",
            "notification:completed_job_notification": "Notification - completed job notification",
            "notification:skipped_job_notification": "Notification - skipped job notification",
            "notification:client_not_assigned": "Notification - Client not assigned",
            "staff:staff_clock_in": "Staff - staff clock in",
            "staff:staff_forgot_to_clock_out": "Staff - staff forgot to clock out",
            "staff:shift_break_started": "Staff - shift break started",
            "staff:shift_break_info": "Staff - shift break info",
            "job:started": "Job - started with info",
            "job:completed": "Job - completed with info start time, end time, job type and price",
            "organization:client_onboarding_form_changed": "Business - client onboarding form changed",
            "organization:cross_sells_changed": "Business - cross sells changed",
            "payroll:shift_info": "Payroll - shift info, work time, start time, end time, mileages, duration, break duration",
            "payroll:tip_info": "Payroll - tip linked to invoice with amount",
            "dog:birthday": "Send webhook on dog birthday 7 days in advance",
            "client:credit_card_link_created": "Private credit card link created for add new credit card"
        }
    }
]
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/token_generate/access_token/12"

const url = new URL(
    "https://openapi.sweepandgo.com/api/token_generate/access_token/12"
);



fetch(url, {
    method: "GET",
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/token_generate/access_token/12';
$response = $client->get($url);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/token_generate/access_token/12'
response = requests.request('GET', url, )
response.json()

Example response (200):

{
    "token": "lrLxIj3PmNkSKdsFdTYYrfLFSungwVl4vXUk9alQo3Zu6cCGpslCGfHI9k2wXLtm",
    "_id": 12
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/token_generate/access_token" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"organization_id\": 2,
    \"webhooks_url\": \"https:\\/\\/example.com\\/webhooks\",
    \"enabled_events\": [
        \"fugit\"
    ],
    \"description\": \"Webhooks for client onboarding events\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/token_generate/access_token"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "organization_id": 2,
    "webhooks_url": "https:\/\/example.com\/webhooks",
    "enabled_events": [
        "fugit"
    ],
    "description": "Webhooks for client onboarding events"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/token_generate/access_token';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'organization_id' => 2,
            'webhooks_url' => 'https://example.com/webhooks',
            'enabled_events' => ['fugit'],
            'description' => 'Webhooks for client onboarding events',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/token_generate/access_token'
payload = {
    "organization_id": 2,
    "webhooks_url": "https:\/\/example.com\/webhooks",
    "enabled_events": [
        "fugit"
    ],
    "description": "Webhooks for client onboarding events"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "token": "lrLxIj3PmNkSKdsFdTYYrfLFSungwVl4vXUk9alQo3Zu6cCGpslCGfHI9k2wXLtm",
    "_id": 12
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/token_generate/access_token/12/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/token_generate/access_token/12/delete"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/token_generate/access_token/12/delete';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/token_generate/access_token/12/delete'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "success": "success"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/health"

const url = new URL(
    "https://openapi.sweepandgo.com/api/health"
);



fetch(url, {
    method: "GET",
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/health';
$response = $client->get($url);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/health'
response = requests.request('GET', url, )
response.json()

Example response (200):

{
    "status": "OK",
    "version": "v1"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/welcome" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/welcome"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/welcome';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/welcome'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "success": "v1",
    "request": {
        "example_param": "example_value"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/welcome" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/welcome"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/welcome';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/welcome'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "success": "v2",
    "request": {
        "example_param": "example_value"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/clients/active?page=2&length=20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/clients/active"
);

const params = {
    "page": "2",
    "length": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/clients/active';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
            'length' => '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/clients/active'
params = {
  'page': '2',
  'length': '20',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "client": "rcl_MTPQPRUUUY7G",
            "status": "active",
            "type": "employee_portal",
            "email": "demo@mail.com",
            "first_name": "John",
            "last_name": "Doe",
            "address": "3289 Summit Street",
            "zip_code": "52801",
            "home_phone": null,
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api",
            "subscription_names": "2w-3d,Deodorising",
            "one_time_client": false,
            "channel": "sms",
            "on_the_way": true,
            "completed": true,
            "off_schedule": false,
            "tracking_field": "utm_campaign=blog_post &utm_medium=social&utm_source=facebook",
            "service_days": "Monday",
            "assigned_to": "Alissa Doe",
            "cleanup_frequency": "once_a_week"
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/clients/active_no_subscription?page=2&length=20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/clients/active_no_subscription"
);

const params = {
    "page": "2",
    "length": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/clients/active_no_subscription';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
            'length' => '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/clients/active_no_subscription'
params = {
  'page': '2',
  'length': '20',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "client": "rcl_MTPQPRUUUY7G",
            "status": "active",
            "type": "employee_portal",
            "email": "demo@mail.com",
            "first_name": "John",
            "last_name": "Doe",
            "address": "3289 Summit Street",
            "zip_code": "52801",
            "home_phone": null,
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api",
            "channel": "sms",
            "on_the_way": true,
            "completed": true,
            "off_schedule": false,
            "subscription_names": "2w-3d,Deodorising",
            "one_time_client": false,
            "tracking_field": "utm_campaign=blog_post &utm_medium=social&utm_source=facebook",
            "service_days": "Monday",
            "assigned_to": "Alissa Doe",
            "cleanup_frequency": "once_a_week"
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/clients/inactive?page=2&length=20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/clients/inactive"
);

const params = {
    "page": "2",
    "length": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/clients/inactive';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
            'length' => '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/clients/inactive'
params = {
  'page': '2',
  'length': '20',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "client": "rcl_MTPQPRUUUY7G",
            "status": "inactive",
            "type": "employee_portal",
            "email": "demo@mail.com",
            "first_name": "John",
            "last_name": "Doe",
            "address": "3289 Summit Street",
            "zip_code": "52801",
            "home_phone": null,
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api",
            "channel": "sms",
            "on_the_way": true,
            "completed": true,
            "off_schedule": false,
            "subscription_names": "",
            "one_time_client": false,
            "tracking_field": "utm_campaign=blog_post &utm_medium=social&utm_source=facebook",
            "service_days": "Monday",
            "assigned_to": "Alissa Doe",
            "cleanup_frequency": "once_a_week"
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/clients/search_by_name?search=John+Doe&page=1&length=20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/clients/search_by_name"
);

const params = {
    "search": "John Doe",
    "page": "1",
    "length": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/clients/search_by_name';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'search' => 'John Doe',
            'page' => '1',
            'length' => '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/clients/search_by_name'
params = {
  'search': 'John Doe',
  'page': '1',
  'length': '20',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "client": "rcl_MTPQPRUUUY7G",
            "status": "active",
            "type": "employee_portal",
            "email": "john.doe@example.com",
            "first_name": "John",
            "last_name": "Doe",
            "address": "3289 Summit Street",
            "city": "Davenport",
            "zip_code": "52801",
            "home_phone": null,
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2026-03-05 10:20:55",
            "marketing_allowed_source": "open_api",
            "subscription_names": "2w-3d, Deodorising",
            "one_time_client": false,
            "channel": "sms",
            "on_the_way": true,
            "completed": true,
            "off_schedule": false,
            "tracking_field": "utm_campaign=blog_post&utm_medium=social",
            "service_days": "Monday",
            "assigned_to": "Alissa Doe",
            "cleanup_frequency": "once_a_week"
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/clients/client_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"client\": \"rcl_MTPQPRUUUY7G\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/clients/client_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "client": "rcl_MTPQPRUUUY7G"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/clients/client_details';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'client' => 'rcl_MTPQPRUUUY7G',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/clients/client_details'
payload = {
    "client": "rcl_MTPQPRUUUY7G"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "client": "rcl_MTPQPRUUUY7G",
    "status": "active",
    "type": "employee_portal",
    "email": "demo@mail.com",
    "first_name": "John",
    "last_name": "Doe",
    "address": "3289 Summit Street",
    "zip_code": "52801",
    "home_phone": "4155550110",
    "cell_phone": "2025550101",
    "marketing_allowed": 1,
    "marketing_allowed_updated_at": "2025-03-05 10:20:55",
    "marketing_allowed_source": "open_api",
    "channel": "sms",
    "on_the_way": true,
    "completed": true,
    "off_schedule": false,
    "tracking_field": "utm_campaign=blog_post &utm_medium=social&utm_source=facebook",
    "service_days": "Monday",
    "assigned_to": "Alissa Doe",
    "cleanup_frequency": "once_a_week",
    "subscription_names": "2d1W",
    "sum_payments": 10,
    "payments": [
        {
            "id": 1049219,
            "date": "2024-05-01",
            "amount": 139.43,
            "tip_amount": "5.00",
            "status": "succeeded",
            "type": "credit_card",
            "description": "Payment for invoice(s) 199-66362-240501-2-1294170",
            "created_at": "2024-05-01 11:19:38"
        },
        {
            "id": 1048709,
            "date": "2024-05-01",
            "amount": 139.43,
            "tip_amount": "0.00",
            "status": "failed",
            "type": "credit_card",
            "description": "Payment for invoice(s) 199-66362-240501-2-1294170",
            "created_at": "2024-05-01 11:11:13"
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/clients/client_search" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"email\": \"john@doe.com\",
    \"status\": \"active\",
    \"latest\": true
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/clients/client_search"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "email": "john@doe.com",
    "status": "active",
    "latest": true
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/clients/client_search';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'email' => 'john@doe.com',
            'status' => 'active',
            'latest' => true,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/clients/client_search'
payload = {
    "email": "john@doe.com",
    "status": "active",
    "latest": true
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "client": "rcl_MTPQPRUUUY7G",
    "status": "active",
    "type": "employee_portal",
    "email": "john@doe.com",
    "first_name": "John",
    "last_name": "Doe",
    "address": "3289 Summit Street",
    "zip_code": "52801",
    "home_phone": "4155550110",
    "cell_phone": "2025550101",
    "marketing_allowed": 1,
    "marketing_allowed_updated_at": "2025-03-05 10:20:55",
    "marketing_allowed_source": "open_api",
    "channel": "sms",
    "on_the_way": true,
    "completed": true,
    "off_schedule": false,
    "tracking_field": "utm_campaign=blog_post &utm_medium=social&utm_source=facebook",
    "service_days": "Monday",
    "assigned_to": "Alissa Doe",
    "cleanup_frequency": "once_a_week",
    "subscription_names": "2d1W"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://openapi.sweepandgo.com/api/v1/residential/onboarding" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"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\",
    \"areas_to_clean\": \"Front Yard, Back Yard\",
    \"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\": [
        \"ea\"
    ],
    \"safe_dog\": [
        \"minima\"
    ],
    \"dog_breed\": [
        \"at\"
    ],
    \"dog_comment\": [
        \"deserunt\"
    ],
    \"cross_sells\": [
        1,
        2,
        5
    ],
    \"cross_sells_names\": \"Spraying,Trash bags,Premium Cleanup\",
    \"coupon_code\": \"5pr1nG\",
    \"marketing_allowed\": 1,
    \"marketing_allowed_source\": \"open_api\",
    \"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
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/residential/onboarding"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "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",
    "areas_to_clean": "Front Yard, Back Yard",
    "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": [
        "ea"
    ],
    "safe_dog": [
        "minima"
    ],
    "dog_breed": [
        "at"
    ],
    "dog_comment": [
        "deserunt"
    ],
    "cross_sells": [
        1,
        2,
        5
    ],
    "cross_sells_names": "Spraying,Trash bags,Premium Cleanup",
    "coupon_code": "5pr1nG",
    "marketing_allowed": 1,
    "marketing_allowed_source": "open_api",
    "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
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/residential/onboarding';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            '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',
            'areas_to_clean' => 'Front Yard, Back Yard',
            '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' => ['ea'],
            'safe_dog' => ['minima'],
            'dog_breed' => ['at'],
            'dog_comment' => ['deserunt'],
            'cross_sells' => [1, 2, 5],
            'cross_sells_names' => 'Spraying,Trash bags,Premium Cleanup',
            'coupon_code' => '5pr1nG',
            'marketing_allowed' => 1,
            'marketing_allowed_source' => 'open_api',
            '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,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/residential/onboarding'
payload = {
    "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",
    "areas_to_clean": "Front Yard, Back Yard",
    "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": [
        "ea"
    ],
    "safe_dog": [
        "minima"
    ],
    "dog_breed": [
        "at"
    ],
    "dog_comment": [
        "deserunt"
    ],
    "cross_sells": [
        1,
        2,
        5
    ],
    "cross_sells_names": "Spraying,Trash bags,Premium Cleanup",
    "coupon_code": "5pr1nG",
    "marketing_allowed": 1,
    "marketing_allowed_source": "open_api",
    "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
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": "success"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/create_client_with_package" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"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\",
    \"postal\": \"28301\",
    \"expiry\": \"0924\",
    \"cleanup_notification_type\": \"on_the_way,completed\",
    \"cleanup_notification_channel\": \"sms\",
    \"how_heard_about_us\": \"social_media\",
    \"how_heard_answer\": \"Facebook\",
    \"gated_community\": \"67890\",
    \"gate_location\": \"left\",
    \"gate_code\": \"1234\",
    \"tracking_field\": \"utm_campaign=blog_post&utm_medium=social&utm_source=facebook\",
    \"marketing_allowed\": 1,
    \"marketing_allowed_source\": \"open_api\",
    \"coupon_code\": \"5pr1nG\",
    \"terms_open_api\": 1,
    \"cross_sells_names\": \"Awesome package\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/create_client_with_package"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "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",
    "postal": "28301",
    "expiry": "0924",
    "cleanup_notification_type": "on_the_way,completed",
    "cleanup_notification_channel": "sms",
    "how_heard_about_us": "social_media",
    "how_heard_answer": "Facebook",
    "gated_community": "67890",
    "gate_location": "left",
    "gate_code": "1234",
    "tracking_field": "utm_campaign=blog_post&utm_medium=social&utm_source=facebook",
    "marketing_allowed": 1,
    "marketing_allowed_source": "open_api",
    "coupon_code": "5pr1nG",
    "terms_open_api": 1,
    "cross_sells_names": "Awesome package"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/create_client_with_package';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            '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',
            'postal' => '28301',
            'expiry' => '0924',
            'cleanup_notification_type' => 'on_the_way,completed',
            'cleanup_notification_channel' => 'sms',
            'how_heard_about_us' => 'social_media',
            'how_heard_answer' => 'Facebook',
            'gated_community' => '67890',
            'gate_location' => 'left',
            'gate_code' => '1234',
            'tracking_field' => 'utm_campaign=blog_post&utm_medium=social&utm_source=facebook',
            'marketing_allowed' => 1,
            'marketing_allowed_source' => 'open_api',
            'coupon_code' => '5pr1nG',
            'terms_open_api' => 1,
            'cross_sells_names' => 'Awesome package',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/create_client_with_package'
payload = {
    "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",
    "postal": "28301",
    "expiry": "0924",
    "cleanup_notification_type": "on_the_way,completed",
    "cleanup_notification_channel": "sms",
    "how_heard_about_us": "social_media",
    "how_heard_answer": "Facebook",
    "gated_community": "67890",
    "gate_location": "left",
    "gate_code": "1234",
    "tracking_field": "utm_campaign=blog_post&utm_medium=social&utm_source=facebook",
    "marketing_allowed": 1,
    "marketing_allowed_source": "open_api",
    "coupon_code": "5pr1nG",
    "terms_open_api": 1,
    "cross_sells_names": "Awesome package"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": "success"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/leads/list?page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/leads/list"
);

const params = {
    "page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/leads/list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/leads/list'
params = {
  'page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "lead": "rld_MTPQPRUUUY7G",
            "status": "active",
            "type": "onboarding_form",
            "email": "demo@mail.com",
            "name": "John Doe",
            "address": "3289 Summit Street",
            "zip_code": "52801",
            "home_phone": null,
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api"
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/leads/out_of_service?page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/leads/out_of_service"
);

const params = {
    "page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/leads/out_of_service';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/leads/out_of_service'
params = {
  'page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "lead": "rld_MTPQPRUUUY7G",
            "status": "lead",
            "type": "out_of_area",
            "email": "demo@mail.com",
            "name": "John Doe",
            "address": "3289 Summit Street",
            "zip_code": "52801",
            "home_phone": null,
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api"
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 10,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/dispatch_board/jobs_for_date?date=2022-03-28" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/dispatch_board/jobs_for_date"
);

const params = {
    "date": "2022-03-28",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/dispatch_board/jobs_for_date';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'date' => '2022-03-28',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/dispatch_board/jobs_for_date'
params = {
  'date': '2022-03-28',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "id": 0,
            "client_location_id": 2603,
            "client_id": null,
            "commercial_location_id": 142,
            "commercial_client_id": 84,
            "pricing_plan_name": "Pet waste stations",
            "commercial": 1,
            "full_name": "Little Lambs Foundation for Kids",
            "address": "1011 W 400 N",
            "city": "Logan",
            "zip": "84321",
            "state_name": "Utah",
            "clean_up_frequency": "1xW",
            "count_cross_sells": 1,
            "price": "25.00",
            "quantity": 1,
            "assigned_to_name": "Bart Cage",
            "assigned_to_id": 265,
            "estimate_time": "00:15",
            "type": "recurring",
            "end_time": null,
            "start_time": null,
            "status_id": 1,
            "status_name": "pending",
            "duration": "-",
            "gate_code": null,
            "gated_community": null,
            "lat": 41.7389868,
            "lng": -111.860119,
            "number_of_dogs": null,
            "safe_dogs": null,
            "home_phone": "4155550110",
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api",
            "email": "demo@demo.com"
        },
        {
            "id": 0,
            "client_location_id": 2726,
            "client_id": 1580,
            "commercial_location_id": null,
            "commercial_client_id": null,
            "pricing_plan_name": "Regular Plan",
            "commercial": 0,
            "full_name": "Cara Deen",
            "address": "625 South 100 West",
            "city": "Garland",
            "zip": "84312",
            "state_name": "Utah",
            "clean_up_frequency": "two_times_a_week",
            "count_cross_sells": 0,
            "price": "25.00",
            "quantity": 1,
            "assigned_to_name": "Richard Dawson",
            "assigned_to_id": 258,
            "estimate_time": "00:15",
            "type": "recurring",
            "end_time": null,
            "start_time": null,
            "status_id": 1,
            "status_name": "pending",
            "duration": "-",
            "gate_code": null,
            "gated_community": null,
            "lat": 41.7344582,
            "lng": -112.1634671,
            "number_of_dogs": 2,
            "safe_dogs": "",
            "home_phone": "4155550110",
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api",
            "email": "demo@demo.com"
        },
        {
            "id": 156608,
            "client_location_id": 2325,
            "type": "recurring",
            "organization_id": 158,
            "client_id": null,
            "full_name": "Community Garden",
            "address": "468 1/2 S 200 W",
            "city": "Logan",
            "zip": "84321",
            "state_name": "Utah",
            "assigned_to_id": 265,
            "assigned_to_name": "Bart Cage",
            "end_time": null,
            "start_time": null,
            "status_id": 6,
            "lat": 41.7228185,
            "lng": -111.8397648,
            "estimate_time": "00:15",
            "job_image": null,
            "image_for_client": null,
            "note": null,
            "note_for_client": null,
            "order": 1,
            "arrival": 4,
            "distance": "3.00",
            "skip_reason_title": null,
            "gate_code": null,
            "count_cross_sells": 1,
            "price": "25.00",
            "quantity": 1,
            "number_of_dogs": null,
            "safe_dogs": null,
            "gated_community": null,
            "commercial": 1,
            "work_areas": null,
            "commercial_client_id": 76,
            "commercial_location_id": 127,
            "start_lat": null,
            "start_lng": null,
            "start_distance": null,
            "clean_up_frequency": null,
            "end_lat": null,
            "end_lng": null,
            "end_distance": null,
            "skip_lat": null,
            "skip_lng": null,
            "skip_distance": null,
            "status_name": "dispatched",
            "duration": "-",
            "home_phone": "4155550110",
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api",
            "email": "demo@demo.com"
        },
        {
            "id": 156890,
            "client_location_id": 2578,
            "type": "custom",
            "organization_id": 158,
            "client_id": 1567,
            "full_name": "Carolina Wozniacki",
            "address": "149 W 300 N",
            "city": "Logan",
            "zip": "84321",
            "state_name": "Utah",
            "assigned_to_id": 246,
            "assigned_to_name": "Ena Adamz",
            "end_time": "2022-03-29 08:24:07",
            "start_time": "2022-03-29 08:22:08",
            "status_id": 2,
            "lat": 41.7374576,
            "lng": -111.8385534,
            "estimate_time": "00:15",
            "job_image": null,
            "image_for_client": null,
            "note": "",
            "note_for_client": "",
            "order": 5,
            "arrival": null,
            "distance": null,
            "skip_reason_title": null,
            "gate_code": null,
            "count_cross_sells": 0,
            "number_of_dogs": 1,
            "safe_dogs": "",
            "gated_community": null,
            "commercial": 0,
            "work_areas": null,
            "commercial_client_id": null,
            "commercial_location_id": null,
            "start_lat": null,
            "start_lng": null,
            "start_distance": null,
            "clean_up_frequency": "bi_weekly",
            "price": "25.00",
            "quantity": 1,
            "end_lat": null,
            "end_lng": null,
            "end_distance": null,
            "skip_lat": null,
            "skip_lng": null,
            "skip_distance": null,
            "status_name": "completed",
            "duration": "00:21",
            "home_phone": "4155550110",
            "cell_phone": "2025550101",
            "marketing_allowed": 1,
            "marketing_allowed_updated_at": "2025-03-05 10:20:55",
            "marketing_allowed_source": "open_api",
            "email": "demo@demo.com"
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/check_token?token=vUcSxeEgTgg0I65bPEgKBqU0AjBRz8cy61843egzKkI3hAcYJ9ErNYe2MTEoIEWo" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/check_token"
);

const params = {
    "token": "vUcSxeEgTgg0I65bPEgKBqU0AjBRz8cy61843egzKkI3hAcYJ9ErNYe2MTEoIEWo",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/check_token';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'token' => 'vUcSxeEgTgg0I65bPEgKBqU0AjBRz8cy61843egzKkI3hAcYJ9ErNYe2MTEoIEWo',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/check_token'
params = {
  'token': 'vUcSxeEgTgg0I65bPEgKBqU0AjBRz8cy61843egzKkI3hAcYJ9ErNYe2MTEoIEWo',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "webhooks_url": "https://example.com/webhooks",
    "enabled_events": "[\"lead:in_service_area\",\"lead:delete\",\"client:changed_status\"]",
    "_id": 1
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/check_zip_code_multi_organizations?zip_code=12345&slugs[]=assumenda" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/check_zip_code_multi_organizations"
);

const params = {
    "zip_code": "12345",
    "slugs[0]": "assumenda",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/check_zip_code_multi_organizations';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'zip_code' => '12345',
            'slugs[0]' => 'assumenda',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/check_zip_code_multi_organizations'
params = {
  'zip_code': '12345',
  'slugs[0]': 'assumenda',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "url": "https://google.com",
    "slug": "ena-adamz-midmc",
    "out_of_area": 1
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/check_premium_organization" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/check_premium_organization"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/check_premium_organization';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/check_premium_organization'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "valid": true,
    "name": "Ena adamz"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/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" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/price_registration_form"
);

const params = {
    "last_time_yard_was_thoroughly_cleaned": "one_week",
    "clean_up_frequency": "once_a_week",
    "number_of_dogs": "2",
    "zip_code": "12345",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/price_registration_form';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'last_time_yard_was_thoroughly_cleaned' => 'one_week',
            'clean_up_frequency' => 'once_a_week',
            'number_of_dogs' => '2',
            'zip_code' => '12345',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/price_registration_form'
params = {
  'last_time_yard_was_thoroughly_cleaned': 'one_week',
  'clean_up_frequency': 'once_a_week',
  'number_of_dogs': '2',
  'zip_code': '12345',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "price": {
        "value": "85.00",
        "category": "prepaid",
        "billing_interval": "monthly"
    },
    "tax_percent": "10.250",
    "tax_percent_others": 1,
    "pricing_zip_code_type": "regular",
    "custom_price": {
        "short_description": "title",
        "long_description": "desc"
    },
    "show_price_options": {
        "show_per_cleanup": 1,
        "show_per_billing_interval": 1,
        "default_billing_interval": "monthly"
    },
    "cross_sells": [
        {
            "id": 1,
            "name": "Deodorizing",
            "description": "Eliminate poop and urine smell!",
            "unit": "Monthly Treatment (up to 1/4 acre)",
            "unit_amount": "39.99",
            "taxable": 1,
            "service": 1,
            "tax_percent": "0.000",
            "count_clients": 28
        },
        {
            "id": 2,
            "name": "Kitty Litter Exchange",
            "description": null,
            "unit": "1",
            "unit_amount": "20.00",
            "taxable": 0,
            "service": 0,
            "tax_percent": "0.000",
            "count_clients": 2
        },
        {
            "id": 3,
            "name": "Dog Walking",
            "description": null,
            "unit": "15",
            "unit_amount": "30.00",
            "taxable": 0,
            "service": 1,
            "tax_percent": "0.000",
            "count_clients": 1
        },
        {
            "id": 4,
            "name": "Yard Size XL",
            "description": "3/4 Acre Surcharge",
            "unit": "Monthly",
            "unit_amount": "30.00",
            "taxable": 0,
            "service": 1,
            "tax_percent": "0.000",
            "count_clients": 0
        },
        {
            "id": 5,
            "name": "Yard Size XXL",
            "description": "1 Acre Surcharge",
            "unit": "Monthly",
            "unit_amount": "40.00",
            "taxable": 0,
            "service": 1,
            "tax_percent": "0.000",
            "count_clients": 0
        },
        {
            "id": 6,
            "name": "Front Yard",
            "description": null,
            "unit": "Weekly",
            "unit_amount": "10.00",
            "taxable": 0,
            "service": 1,
            "tax_percent": "0.000",
            "count_clients": 1
        },
        {
            "id": 7,
            "name": "Front Yard",
            "description": null,
            "unit": "Monthly",
            "unit_amount": "40.00",
            "taxable": 0,
            "service": 1,
            "tax_percent": "0.000",
            "count_clients": 0
        }
    ],
    "cross_sells_placement": "top"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/client_on_boarding/service_registration_form" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/service_registration_form"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/service_registration_form';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/service_registration_form'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "form_fields": [
        {
            "value": "",
            "required": false,
            "step": 2,
            "frontend_name": "Coupon Code",
            "frontend_type": "textfield",
            "slug": "coupon_code",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "1,2,3,4,5",
            "required": true,
            "step": 2,
            "frontend_name": "Number Of Dogs",
            "frontend_type": "select_single",
            "slug": "number_of_dogs",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "two_times_a_week,once_a_week,bi_weekly,once_a_month,one_time",
            "required": true,
            "step": 2,
            "frontend_name": "Cleanup Frequency",
            "frontend_type": "select_single",
            "slug": "clean_up_frequency",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "one_week,two_weeks,three_weeks,one_month,two_months,3-4_months,5-6_months,7-9_months,10+_months",
            "required": true,
            "step": 2,
            "frontend_name": "Last Time Yard Was Thoroughly Cleaned",
            "frontend_type": "select_single",
            "slug": "last_time_yard_was_thoroughly_cleaned",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "First Name",
            "frontend_type": "textfield",
            "slug": "first_name",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "Last Name",
            "frontend_type": "textfield",
            "slug": "last_name",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "Your Email Address",
            "frontend_type": "textfield",
            "slug": "your_email_address",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "Confirm Email Address",
            "frontend_type": "textfield",
            "slug": "confirm_email_address",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": false,
            "step": 3,
            "frontend_name": "Home Phone Number",
            "frontend_type": "textfield",
            "slug": "home_phone_number",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "Cell Phone Number",
            "frontend_type": "textfield",
            "slug": "cell_phone_number",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "Home Address",
            "frontend_type": "textfield",
            "slug": "home_address",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "City",
            "frontend_type": "textfield",
            "slug": "city",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "State",
            "frontend_type": "state",
            "slug": "state_province_region",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": false,
            "step": 3,
            "frontend_name": "Dogs Name",
            "frontend_type": "textfield",
            "slug": "dogs_name",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "yes,no",
            "required": true,
            "step": 3,
            "frontend_name": "Is it safe for us to be in the yard with your dog?",
            "frontend_type": "select_single",
            "slug": "safe_dog",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": false,
            "step": 3,
            "frontend_name": "Breed",
            "frontend_type": "textfield",
            "slug": "dogs_breeds",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": false,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": false,
            "step": 3,
            "frontend_name": "Additional comment for dog",
            "frontend_type": "textfield",
            "slug": "comments_for_each_dog",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "left,right,alley,no_gate,other",
            "required": true,
            "step": 3,
            "frontend_name": "Where is your gate located?",
            "frontend_type": "select_single",
            "slug": "gate_location",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": true,
            "step": 3,
            "frontend_name": "Gated community",
            "frontend_type": "textfield",
            "slug": "gated_community",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": "Please insert the code if any"
        },
        {
            "value": "Back Yard,Flower Beds,Deck/Patio,Dog Run,Garden,Side Yard (Left),Side Yard (Right),Area with Mulch,Area with Rocks",
            "required": true,
            "step": 3,
            "frontend_name": "Which areas should we clean?",
            "frontend_type": "select_multiple",
            "slug": "areas_to_clean",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "off_schedule,on_the_way,completed",
            "required": true,
            "step": 3,
            "frontend_name": "Cleanup Notifications",
            "frontend_type": "select_multiple",
            "slug": "cleanup_notification_type",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": "What cleanup message would you like to receive?"
        },
        {
            "value": "email,sms,call",
            "required": false,
            "step": 3,
            "frontend_name": "Notification Type",
            "frontend_type": "select_single",
            "slug": "cleanup_notification_chanel",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": "How would you like to receive cleanup notifications?"
        },
        {
            "value": "credit_card,check",
            "required": true,
            "step": 3,
            "frontend_name": "Please select your payment method",
            "frontend_type": "select_single",
            "slug": "payment_method",
            "organization_form_id": 289,
            "one_time": false,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "search_engine,previous_client,referred_by_family_or_friend,directory_listing,social_media,vehicle_signage,radio_ad,local_event,gift_certificate,other",
            "required": true,
            "step": 3,
            "frontend_name": "Please tell us how you heard about us",
            "frontend_type": "select_single",
            "slug": "how_heard_about_us",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        },
        {
            "value": "",
            "required": false,
            "step": 3,
            "frontend_name": "Additional comments",
            "frontend_type": "textfield",
            "slug": "additional_comment",
            "organization_form_id": 289,
            "one_time": true,
            "recurring": true,
            "show": true,
            "frontend_description": ""
        }
    ],
    "terms_of_use": {
        "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>"
    },
    "callout_disclaimer": {
        "callout": "Our Best Rate! You and Your pet will love our service.",
        "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."
    },
    "states": [
        {
            "id": 1,
            "name": "Alabama - AL"
        },
        {
            "id": 2,
            "name": "Alaska - AK"
        },
        {
            "id": 3,
            "name": "Arizona - AZ"
        },
        {
            "id": 4,
            "name": "Arkansas - AR"
        },
        {
            "id": 5,
            "name": "California - CA"
        },
        {
            "id": 6,
            "name": "Colorado - CO"
        },
        {
            "id": 7,
            "name": "Connecticut - CT"
        },
        {
            "id": 8,
            "name": "Delaware - DE"
        },
        {
            "id": 9,
            "name": "District of Columbia - DC"
        },
        {
            "id": 10,
            "name": "Florida - FL"
        },
        {
            "id": 11,
            "name": "Georgia - GA"
        },
        {
            "id": 12,
            "name": "Hawaii - HI"
        },
        {
            "id": 13,
            "name": "Idaho - ID"
        },
        {
            "id": 14,
            "name": "Illinois - IL"
        },
        {
            "id": 15,
            "name": "Indiana - IN"
        },
        {
            "id": 16,
            "name": "Iowa - IA"
        },
        {
            "id": 17,
            "name": "Kansas - KS"
        },
        {
            "id": 18,
            "name": "Kentucky - KY"
        },
        {
            "id": 19,
            "name": "Louisiana - LA"
        },
        {
            "id": 20,
            "name": "Maine - ME"
        },
        {
            "id": 33,
            "name": "Maryland - MD"
        },
        {
            "id": 34,
            "name": "Massachusetts - MA"
        },
        {
            "id": 35,
            "name": "Michigan - MI"
        },
        {
            "id": 36,
            "name": "Minnesota - MN"
        },
        {
            "id": 37,
            "name": "Mississippi - MS"
        },
        {
            "id": 38,
            "name": "Missouri - MO"
        },
        {
            "id": 21,
            "name": "Montana - MT"
        },
        {
            "id": 22,
            "name": "Nebraska - NE"
        },
        {
            "id": 23,
            "name": "Nevada - NV"
        },
        {
            "id": 24,
            "name": "New Hampshire - NH"
        },
        {
            "id": 25,
            "name": "New Jersey - NJ"
        },
        {
            "id": 26,
            "name": "New Mexico - NM"
        },
        {
            "id": 27,
            "name": "New York - NY"
        },
        {
            "id": 28,
            "name": "North Carolina - NC"
        },
        {
            "id": 29,
            "name": "North Dakota - ND"
        },
        {
            "id": 30,
            "name": "Ohio - OH"
        },
        {
            "id": 31,
            "name": "Oklahoma - OK"
        },
        {
            "id": 32,
            "name": "Oregon - OR"
        },
        {
            "id": 39,
            "name": "Pennsylvania - PA"
        },
        {
            "id": 40,
            "name": "Rhode Island - RI"
        },
        {
            "id": 41,
            "name": "South Carolina - SC"
        },
        {
            "id": 42,
            "name": "South Dakota - SD"
        },
        {
            "id": 43,
            "name": "Tennessee - TN"
        },
        {
            "id": 44,
            "name": "Texas - TX"
        },
        {
            "id": 45,
            "name": "Utah - UT"
        },
        {
            "id": 46,
            "name": "Vermont - VT"
        },
        {
            "id": 47,
            "name": "Virginia - VA"
        },
        {
            "id": 48,
            "name": "Washington - WA"
        },
        {
            "id": 49,
            "name": "West Virginia - WV"
        },
        {
            "id": 50,
            "name": "Wisconsin - WI"
        },
        {
            "id": 51,
            "name": "Wyoming - WY"
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/client_on_boarding/organization_data" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/organization_data"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/organization_data';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/organization_data'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "organization": {
        "analytic_enabled": 1,
        "branding_color": "#39A597",
        "business_address": "1502 Morse St",
        "business_city": "Houston",
        "business_lat": "29.7521804",
        "business_lng": "-95.4058215",
        "business_name": "Magnificent Scoopers 777",
        "business_phone": "2025550101",
        "business_state": "Texas",
        "business_website": "https://www.sweepandgo.com/",
        "business_zip": "77019",
        "can_call_company_phone_client_portal": "1",
        "can_text_company_phone_client_portal": "1",
        "card_connect_site": null,
        "charges_enabled": 1,
        "commercial_inventory_tracking": "0",
        "ga_tracking_id": "null",
        "logo": "",
        "organization": "magnificent-scoopers-777-p4ycx",
        "organization_can_have_onboarding": true,
        "organization_id": 161,
        "organization_name": "Magnificent Scoopers 777",
        "organization_status": "active",
        "pay_period": "monthly",
        "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",
        "rating_tipping": "enabled_all",
        "send_invoice_email": "1",
        "show_company_address_client_portal": "1",
        "show_company_email_client_portal": "1",
        "show_company_phone_client_portal": "1",
        "show_logo_onboarding": "1",
        "show_name_onboarding": "0",
        "show_on_list": "0",
        "show_payroll_filed_tech": "1",
        "show_rating_comment_fieldtech": "1",
        "subscription_package": "Professional",
        "website": "http://www.superskooopers.com"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/client_on_boarding/coupon_find_default" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/coupon_find_default"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/coupon_find_default';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/coupon_find_default'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "coupon": {
        "coupon_id": "50POFF",
        "coupon_name": "Spring Season",
        "percent_off": "20",
        "amount_off": null,
        "duration_in_months": 0,
        "duration": "once"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/client_on_boarding/coupon_find?coupon_id=5pr1nG" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/coupon_find"
);

const params = {
    "coupon_id": "5pr1nG",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/coupon_find';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'coupon_id' => '5pr1nG',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/coupon_find'
params = {
  'coupon_id': '5pr1nG',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "coupon": {
        "percent_off": "25.00",
        "amount_off": null,
        "duration_in_months": 3,
        "duration": "repeating",
        "coupon_id": "5pr1nG",
        "coupon_name": "Spring Sale NEW"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/client_on_boarding/check_client_email_exists?email=john%40doe.com" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/check_client_email_exists"
);

const params = {
    "email": "john@doe.com",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/check_client_email_exists';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'email' => 'john@doe.com',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/check_client_email_exists'
params = {
  'email': 'john@doe.com',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "exists": true
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/client_on_boarding/thank_you_pages" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/thank_you_pages"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/thank_you_pages';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/thank_you_pages'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "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>"
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/client_on_boarding/out_of_service_form" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/out_of_service_form"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/out_of_service_form';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/out_of_service_form'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "form_fields": [
        {
            "id": 4658,
            "organization_form_id": 290,
            "frontend_type": "textfield",
            "frontend_description": "",
            "backend_description": "",
            "slug": "zip_code",
            "step": 3,
            "frontend_name": "Zip code",
            "backend_name": "Zip code",
            "one_time": true,
            "recurring": true,
            "show": true,
            "required": true,
            "optional_show": true,
            "optional_required": false,
            "backend_type": "textfield",
            "value": "",
            "options": "",
            "locked": false,
            "backend_sort": 27,
            "frontend_sort": 27,
            "locked_options": false,
            "hint": ""
        },
        {
            "id": 4659,
            "organization_form_id": 290,
            "frontend_type": "textfield",
            "frontend_description": "",
            "backend_description": "",
            "slug": "name",
            "step": 3,
            "frontend_name": "Name",
            "backend_name": "Name",
            "one_time": true,
            "recurring": true,
            "show": true,
            "required": true,
            "optional_show": true,
            "optional_required": false,
            "backend_type": "textfield",
            "value": "",
            "options": "",
            "locked": false,
            "backend_sort": 28,
            "frontend_sort": 28,
            "locked_options": false,
            "hint": ""
        },
        {
            "id": 4660,
            "organization_form_id": 290,
            "frontend_type": "textfield",
            "frontend_description": "",
            "backend_description": "",
            "slug": "email_address",
            "step": 3,
            "frontend_name": "Email address",
            "backend_name": "Email address",
            "one_time": true,
            "recurring": true,
            "show": true,
            "required": true,
            "optional_show": true,
            "optional_required": false,
            "backend_type": "textfield",
            "value": "",
            "options": "",
            "locked": false,
            "backend_sort": 29,
            "frontend_sort": 29,
            "locked_options": false,
            "hint": ""
        },
        {
            "id": 4662,
            "organization_form_id": 290,
            "frontend_type": "textfield",
            "frontend_description": "",
            "backend_description": "",
            "slug": "phone",
            "step": 3,
            "frontend_name": "Phone number",
            "backend_name": "Phone number",
            "one_time": true,
            "recurring": true,
            "show": true,
            "required": false,
            "optional_show": true,
            "optional_required": false,
            "backend_type": "textfield",
            "value": "",
            "options": "",
            "locked": false,
            "backend_sort": 30,
            "frontend_sort": 30,
            "locked_options": false,
            "hint": ""
        },
        {
            "id": 4661,
            "organization_form_id": 290,
            "frontend_type": "textfield",
            "frontend_description": "",
            "backend_description": "",
            "slug": "address",
            "step": 3,
            "frontend_name": "Address",
            "backend_name": "Address",
            "one_time": true,
            "recurring": true,
            "show": true,
            "required": true,
            "optional_show": true,
            "optional_required": false,
            "backend_type": "textfield",
            "value": "",
            "options": "",
            "locked": false,
            "backend_sort": 31,
            "frontend_sort": 31,
            "locked_options": false,
            "hint": ""
        },
        {
            "id": 4663,
            "organization_form_id": 290,
            "frontend_type": "textfield",
            "frontend_description": "",
            "backend_description": "",
            "slug": "comment",
            "step": 3,
            "frontend_name": "Comment",
            "backend_name": "Comment",
            "one_time": true,
            "recurring": true,
            "show": true,
            "required": false,
            "optional_show": true,
            "optional_required": false,
            "backend_type": "textfield",
            "value": "",
            "options": "",
            "locked": false,
            "backend_sort": 32,
            "frontend_sort": 32,
            "locked_options": false,
            "hint": ""
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/out_of_service_form" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"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\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/out_of_service_form"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "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"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/out_of_service_form';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            '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',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/out_of_service_form'
payload = {
    "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"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": "success"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/check_zip_code_exists" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"value\": \"12345\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/client_on_boarding/check_zip_code_exists"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "value": "12345"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/check_zip_code_exists';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'value' => '12345',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/client_on_boarding/check_zip_code_exists'
payload = {
    "value": "12345"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "exists": "not_exists"
}
 

Example response (200):

{
    "exists": "exists"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/one_time_payment/check_invoice?invoice_number=3-3-190207-2-4" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/one_time_payment/check_invoice"
);

const params = {
    "invoice_number": "3-3-190207-2-4",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/one_time_payment/check_invoice';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'invoice_number' => '3-3-190207-2-4',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/one_time_payment/check_invoice'
params = {
  'invoice_number': '3-3-190207-2-4',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "invoice_remaining": "12.23",
    "payment_gateway": "fts/stripe/none"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://openapi.sweepandgo.com/api/v2/one_time_payment/stripe_payment" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"invoice_number\": \"3-3-190207-2-4\",
    \"amount\": \"67.98\",
    \"name_on_card\": \"John Doe\",
    \"token\": \"tok_1E0rfhHLLICwofnx4bUzDZis\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/one_time_payment/stripe_payment"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "invoice_number": "3-3-190207-2-4",
    "amount": "67.98",
    "name_on_card": "John Doe",
    "token": "tok_1E0rfhHLLICwofnx4bUzDZis"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/one_time_payment/stripe_payment';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'invoice_number' => '3-3-190207-2-4',
            'amount' => '67.98',
            'name_on_card' => 'John Doe',
            'token' => 'tok_1E0rfhHLLICwofnx4bUzDZis',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/one_time_payment/stripe_payment'
payload = {
    "invoice_number": "3-3-190207-2-4",
    "amount": "67.98",
    "name_on_card": "John Doe",
    "token": "tok_1E0rfhHLLICwofnx4bUzDZis"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "status": "paid"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://openapi.sweepandgo.com/api/v1/invoice/one_time" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"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\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/invoice/one_time"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "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"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/invoice/one_time';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            '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',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/invoice/one_time'
payload = {
    "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"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": "success"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/report/count_happy_dogs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/report/count_happy_dogs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/report/count_happy_dogs';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/report/count_happy_dogs'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "data": 23
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/report/count_happy_clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/report/count_happy_clients"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/report/count_happy_clients';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/report/count_happy_clients'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "data": 23
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/report/count_active_clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/report/count_active_clients"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/report/count_active_clients';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/report/count_active_clients'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "data": 23
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/report/jobs_count" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/report/jobs_count"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/report/jobs_count';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/report/jobs_count'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "data": 23
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/report/staff_select_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/report/staff_select_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/report/staff_select_list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/report/staff_select_list'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "data": [
        {
            "id": 1,
            "name": "John Doe",
            "email": "john@doe.com",
            "color": "#87332",
            "phone": "2025550101",
            "status": "active"
        },
        {
            "id": 2,
            "name": "Jane Doe",
            "email": "jane@doe.com",
            "color": "#3355AA",
            "phone": "2025550102",
            "status": "active"
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/report/route_planning_report?date=2026-09-21" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/report/route_planning_report"
);

const params = {
    "date": "2026-09-21",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/report/route_planning_report';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'date' => '2026-09-21',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/report/route_planning_report'
params = {
  'date': '2026-09-21',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "route_reports": [
        {
            "assigned_to_name": "John Doe",
            "date": "2026-09-21",
            "duration": 240,
            "driving_time": 60,
            "cleanup_time": 180,
            "distance": 68.4,
            "number_of_jobs": 18,
            "price": 540
        },
        {
            "assigned_to_name": "Emma Doe",
            "date": "2026-09-21",
            "duration": 180,
            "driving_time": 45,
            "cleanup_time": 135,
            "distance": 51.2,
            "number_of_jobs": 12,
            "price": 375.5
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/report/completed_jobs_report?date=2026-07-13&date_from=2026-01-01&date_to=2026-01-31" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/report/completed_jobs_report"
);

const params = {
    "date": "2026-07-13",
    "date_from": "2026-01-01",
    "date_to": "2026-01-31",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/report/completed_jobs_report';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'date' => '2026-07-13',
            'date_from' => '2026-01-01',
            'date_to' => '2026-01-31',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/report/completed_jobs_report'
params = {
  'date': '2026-07-13',
  'date_from': '2026-01-01',
  'date_to': '2026-01-31',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "job_list": [
        {
            "commercial_name": null,
            "type": "custom",
            "quantity": 1,
            "first_name": "Pete",
            "last_name": "Peterson",
            "address": "149 W 300 N",
            "city": "Logan",
            "zip": "84321",
            "state_name": "Utah",
            "assigned_to_name": "John Doe",
            "assigned_to_id": 509,
            "status_id": 2,
            "start_time": "2026-07-13 04:30:59",
            "end_time": "2026-07-13 04:40:25",
            "pricing_plan_name": "Regular Plan",
            "service_plan_name": "1d-1xW",
            "service_plan_slug": "once_a_week",
            "date": "2026-07-13",
            "note": null,
            "skip_reason_title": null,
            "count_cross_sells": 0,
            "price": "25.00",
            "additional_services": null,
            "status_name": "completed",
            "duration": "9:26",
            "service_label": null
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/gift_card" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"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\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/gift_card"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "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"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/gift_card';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            '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',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/gift_card'
payload = {
    "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"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": "success"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/coupon" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"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
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/coupon"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "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
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/coupon';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            '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,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/coupon'
payload = {
    "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
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": "success",
    "coupon": {
        "coupon_id": "5pr1nG",
        "name": "Spring Season"
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/free_quotes" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/free_quotes"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/free_quotes';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/free_quotes'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "free_quotes": [
        {
            "coupon_code": "UKdJ5C0W",
            "number_of_dogs": "4",
            "clean_up_frequency": "five_times_a_week",
            "last_time_yard_was_thoroughly_cleaned": "two_months",
            "your_email_address": "client@example.com",
            "cell_phone_number": "2025550101",
            "marketing_allowed": 1,
            "first_name": "Ena",
            "last_name": "Doe",
            "created_at": "2026-02-15 10:42:31"
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/text-inbound/on-the-way/check-dogs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"From\": \"12025550102\",
    \"To\": \"12025550101\",
    \"SmsMessageSid\": \"89iwieweow8e49038408902\",
    \"Body\": \"ENT\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/text-inbound/on-the-way/check-dogs"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "From": "12025550102",
    "To": "12025550101",
    "SmsMessageSid": "89iwieweow8e49038408902",
    "Body": "ENT"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/text-inbound/on-the-way/check-dogs';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'From' => '12025550102',
            'To' => '12025550101',
            'SmsMessageSid' => '89iwieweow8e49038408902',
            'Body' => 'ENT',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/text-inbound/on-the-way/check-dogs'
payload = {
    "From": "12025550102",
    "To": "12025550101",
    "SmsMessageSid": "89iwieweow8e49038408902",
    "Body": "ENT"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": "success"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/text-twilio/on-the-way/webhook" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"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
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/text-twilio/on-the-way/webhook"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "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
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/text-twilio/on-the-way/webhook';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            '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,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/text-twilio/on-the-way/webhook'
payload = {
    "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
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "success": "success"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/packages_list" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/packages_list"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/packages_list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/packages_list'
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers)
response.json()

Example response (200):

{
    "cross_sells": [
        {
            "id": 201,
            "name": "Starter Package",
            "description": "Essential tools to get started with our service.",
            "unit": "bundle",
            "unit_amount": "20.00",
            "taxable": 1,
            "service": 0,
            "tax_percent": "5.000",
            "package": 1,
            "package_order": 1,
            "featured": 1,
            "featured_label": "Most Popular",
            "descriptions": "Includes basic deodorizer, gloves, and poop bags.",
            "button_color": "#4CAF50",
            "background_color": "#E8F5E9",
            "featured_color": "#FFC107",
            "cleanup_frequency": "weekly",
            "count_clients": 110
        },
        {
            "id": 202,
            "name": "Premium Package",
            "description": "Full service kit with advanced cleaning solutions.",
            "unit": "box",
            "unit_amount": "40.00",
            "taxable": 1,
            "service": 0,
            "tax_percent": "5.000",
            "package": 1,
            "package_order": 2,
            "featured": 0,
            "featured_label": null,
            "descriptions": "Includes premium scented sprays, large bags, and protective wear.",
            "button_color": "#2196F3",
            "background_color": "#E3F2FD",
            "featured_color": null,
            "cleanup_frequency": "bi-weekly",
            "count_clients": 65
        }
    ],
    "cross_sells_placement": "top",
    "billing_interval": "monthly",
    "category": "cleanup"
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/webhooks/index"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/webhooks/index"
);



fetch(url, {
    method: "GET",
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/webhooks/index';
$response = $client->get($url);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/webhooks/index'
response = requests.request('GET', url, )
response.json()

Example response (403):

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "errors": [
        "Authorization failed"
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v1/webhooks/list?page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/webhooks/list"
);

const params = {
    "page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/webhooks/list';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/webhooks/list'
params = {
  'page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (403):

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "errors": [
        "API key is not valid"
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request PUT \
    "https://openapi.sweepandgo.com/api/v1/webhooks/retry" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"id\": \"e0e03073-a1a3-4f6e-82ff-81dab3772534\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v1/webhooks/retry"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "id": "e0e03073-a1a3-4f6e-82ff-81dab3772534"
};

fetch(url, {
    method: "PUT",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v1/webhooks/retry';
$response = $client->put(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'id' => 'e0e03073-a1a3-4f6e-82ff-81dab3772534',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v1/webhooks/retry'
payload = {
    "id": "e0e03073-a1a3-4f6e-82ff-81dab3772534"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('PUT', url, headers=headers, json=payload)
response.json()

Example response (403):

cache-control: no-cache, private
content-type: application/json
access-control-allow-origin: *
 

{
    "errors": [
        "API key is not valid"
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/invoices?page=1&length=20&type=recurring" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/invoices"
);

const params = {
    "page": "1",
    "length": "20",
    "type": "recurring",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/invoices';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '1',
            'length' => '20',
            'type' => 'recurring',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/invoices'
params = {
  'page': '1',
  'length': '20',
  'type': 'recurring',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "invoices": {
        "current_page": 1,
        "data": [
            {
                "created_at": "2026-07-02 00:03:23",
                "tip_amount": "0.00",
                "next_try_charging": null,
                "commercial_client": "Test Business",
                "commercial_location": "Location 1",
                "invoice_number": "323-270-260702-8-62215",
                "client_name": "Test Business",
                "pay_method": "check",
                "status": "paid",
                "total": "12.00",
                "type": "subscription",
                "remaining": "0.00",
                "category": "postpaid",
                "billing_interval": "weekly",
                "refunded": "0.00",
                "paid": "12.00",
                "period_end": "2026-07-09 00:03:23",
                "period_start": "2026-07-02 00:03:23"
            },
            {
                "created_at": "2026-07-14 05:03:02",
                "tip_amount": "0.00",
                "next_try_charging": null,
                "commercial_client": null,
                "commercial_location": null,
                "invoice_number": "127-1104-200521-2-5830",
                "client_name": "Frankie Hooper",
                "pay_method": "credit_card",
                "status": "paid",
                "total": "52.67",
                "type": "subscription",
                "remaining": "0.00",
                "category": "prepaid",
                "billing_interval": "daily",
                "refunded": "0.00",
                "paid": "52.67",
                "period_end": "2026-07-15 05:03:02",
                "period_start": "2026-07-14 05:03:02"
            }
        ],
        "per_page": 10,
        "from": 1,
        "to": 10,
        "total": 31,
        "last_page": 4,
        "next_page_url": "https://api.example.com/api/invoices/recurring?page=2",
        "prev_page_url": null
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/payments?page=1&length=20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/payments"
);

const params = {
    "page": "1",
    "length": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/payments';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '1',
            'length' => '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/payments'
params = {
  'page': '1',
  'length': '20',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "payments": {
        "current_page": 1,
        "data": [
            {
                "date": "2026-07-06",
                "amount": 22,
                "amount_refunded": "0.00",
                "status": "succeeded",
                "type": "credit_card",
                "description": "Payment for invoice 127-1060-200318-2-4420",
                "client_name": "John Doe",
                "tip_amount": "0.00",
                "commercial_location": null,
                "commercial_client": null
            }
        ],
        "per_page": 10,
        "from": 1,
        "to": 10,
        "total": 300,
        "last_page": 30,
        "next_page_url": "https://api.example.com/api/payments?page=2",
        "prev_page_url": null
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/subscriptions?page=1&length=20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/subscriptions"
);

const params = {
    "page": "1",
    "length": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/subscriptions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '1',
            'length' => '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/subscriptions'
params = {
  'page': '1',
  'length': '20',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "subscriptions": {
        "current_page": 1,
        "data": [
            {
                "status": "active",
                "category": "cleanup",
                "billing_interval": "monthly",
                "start_date": "2026-08-05",
                "end_date": null,
                "current_period_end": "2026-08-23 04:02:25",
                "canceled_at": null,
                "client_name": "John Doe",
                "client_email": "johndoe@email.com",
                "client_address": "Test Street, Test City, Texas 88595",
                "name": null,
                "price": 20,
                "pricing_plan": "Regular Plan",
                "service_plan": "2d-1xW",
                "frequency": "once_a_week",
                "number_of_dogs": "2",
                "zip_code": "88595",
                "termination_reason": null,
                "termination_comment": null,
                "termination_note": null,
                "pause_start_date": null,
                "pause_end_date": null,
                "pause_reason": null,
                "coupon_code": null,
                "coupon_total": null,
                "coupon_percent": null,
                "coupon_added": null,
                "coupon_end": null,
                "tip_amount": null,
                "tip_added": null
            }
        ],
        "per_page": 10,
        "from": 1,
        "to": 10,
        "total": 300,
        "last_page": 30,
        "next_page_url": "https://api.example.com/api/subscriptions?page=2",
        "prev_page_url": null
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/commercial/subscriptions?page=1&length=20" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/commercial/subscriptions"
);

const params = {
    "page": "1",
    "length": "20",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/commercial/subscriptions';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '1',
            'length' => '20',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/commercial/subscriptions'
params = {
  'page': '1',
  'length': '20',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "subscriptions": {
        "current_page": 1,
        "data": [
            {
                "status": "active",
                "category": "postpaid",
                "billing_interval": "monthly",
                "start_date": "2026-01-27",
                "end_date": null,
                "current_period_end": "2026-06-27 04:03:23",
                "canceled_at": null,
                "commercial_client": "Test Commercial",
                "commercial_location": "Test Location",
                "client_name": "Test Company",
                "client_email": "testclient12345@email.com",
                "client_address": "Test Street, Test City, Arizona 85001",
                "service_name": "Test service",
                "frequency": "2xW",
                "price": 30,
                "termination_reason": null,
                "termination_comment": null,
                "termination_note": null,
                "pause_start_date": null,
                "pause_end_date": null,
                "pause_reason": null,
                "tip_amount": null,
                "tip_added": null
            }
        ],
        "per_page": 10,
        "from": 1,
        "to": 10,
        "total": 300,
        "last_page": 30,
        "next_page_url": "https://api.example.com/api/commercial/subscriptions?page=2",
        "prev_page_url": null
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/commercial_clients/active?page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/commercial_clients/active"
);

const params = {
    "page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/active';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/active'
params = {
  'page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "client": "cc_MTPQPRUUUY7G",
            "name": "Acme Corporation",
            "status": "active",
            "locations_count": 2,
            "subscription_names": "2w-3d,Deodorising",
            "locations": [
                {
                    "location": "cl_ABCDEF123456",
                    "name": "Downtown Office",
                    "status": "active",
                    "email": "office@acme.com",
                    "billing_company_name": "Acme Corporation",
                    "billing_first_name": "John",
                    "billing_last_name": "Doe",
                    "billing_address": "3289 Summit Street",
                    "billing_city": "Davenport",
                    "billing_state": "Iowa",
                    "billing_zip": "52801",
                    "billing_country": "United States",
                    "subscription_names": "2w-3d",
                    "service_days": "Monday",
                    "assigned_to": "Alissa Doe",
                    "cleanup_frequency": "Once a week"
                }
            ]
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 15,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/commercial_clients/inactive?page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/commercial_clients/inactive"
);

const params = {
    "page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/inactive';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/inactive'
params = {
  'page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "client": "cc_MTPQPRUUUY7G",
            "name": "Acme Corporation",
            "status": "inactive",
            "locations_count": 1,
            "subscription_names": "",
            "locations": []
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 15,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request GET \
    --get "https://openapi.sweepandgo.com/api/v2/commercial_clients/with_subscription?page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/commercial_clients/with_subscription"
);

const params = {
    "page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Accept": "application/json",
};


fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/with_subscription';
$response = $client->get(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
        ],
        'query' => [
            'page' => '2',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/with_subscription'
params = {
  'page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}'
}

response = requests.request('GET', url, headers=headers, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "client": "cc_MTPQPRUUUY7G",
            "name": "Acme Corporation",
            "status": "active",
            "locations_count": 1,
            "subscription_names": "2w-3d,Deodorising",
            "locations": [
                {
                    "location": "cl_ABCDEF123456",
                    "name": "Downtown Office",
                    "status": "active",
                    "subscription_names": "2w-3d,Deodorising",
                    "service_days": "Monday",
                    "assigned_to": "Alissa Doe",
                    "cleanup_frequency": "Once a week"
                }
            ]
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 15,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/commercial_clients/search?page=2" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"q\": \"Acme\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/commercial_clients/search"
);

const params = {
    "page": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "q": "Acme"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/search';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'query' => [
            'page' => '2',
        ],
        'json' => [
            'q' => 'Acme',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/search'
payload = {
    "q": "Acme"
}
params = {
  'page': '2',
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload, params=params)
response.json()

Example response (200):

{
    "data": [
        {
            "client": "cc_MTPQPRUUUY7G",
            "name": "Acme Corporation",
            "status": "active",
            "locations_count": 1,
            "subscription_names": "2w-3d",
            "locations": [
                {
                    "location": "cl_ABCDEF123456",
                    "name": "Downtown Office",
                    "status": "active",
                    "subscription_names": "2w-3d",
                    "service_days": "Monday",
                    "assigned_to": "Alissa Doe",
                    "cleanup_frequency": "Once a week",
                    "contacts": [
                        {
                            "company": false,
                            "first_name": "John",
                            "last_name": "Doe",
                            "role": "Owner",
                            "email": "john@acme.com",
                            "phone": "2025550101"
                        }
                    ]
                }
            ]
        }
    ],
    "paginate": {
        "total": 1,
        "count": 1,
        "per_page": 15,
        "current_page": 1,
        "total_pages": 1
    }
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.

Example request:

curl --request POST \
    "https://openapi.sweepandgo.com/api/v2/commercial_clients/client_details" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --data "{
    \"client\": \"cc_MTPQPRUUUY7G\"
}"

const url = new URL(
    "https://openapi.sweepandgo.com/api/v2/commercial_clients/client_details"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "client": "cc_MTPQPRUUUY7G"
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

$client = new \GuzzleHttp\Client();
$url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/client_details';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
        ],
        'json' => [
            'client' => 'cc_MTPQPRUUUY7G',
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://openapi.sweepandgo.com/api/v2/commercial_clients/client_details'
payload = {
    "client": "cc_MTPQPRUUUY7G"
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

Example response (200):

{
    "client": "cc_MTPQPRUUUY7G",
    "name": "Acme Corporation",
    "status": "active",
    "locations_count": 1,
    "subscription_names": "2w-3d",
    "locations": [
        {
            "location": "cl_ABCDEF123456",
            "name": "Downtown Office",
            "status": "active",
            "email": "office@acme.com",
            "billing_company_name": "Acme Corporation",
            "billing_first_name": "John",
            "billing_last_name": "Doe",
            "billing_address": "3289 Summit Street",
            "billing_city": "Davenport",
            "billing_state": "Iowa",
            "billing_zip": "52801",
            "billing_country": "United States",
            "subscription_names": "2w-3d",
            "service_days": "Monday",
            "assigned_to": "Alissa Doe",
            "cleanup_frequency": "Once a week",
            "contacts": [
                {
                    "company": false,
                    "first_name": "John",
                    "last_name": "Doe",
                    "company_name": null,
                    "role": "Owner",
                    "email": "john@acme.com",
                    "phone": "2025550101",
                    "address": "3289 Summit Street",
                    "city": "Davenport",
                    "state": "Iowa",
                    "zip": "52801",
                    "country": "United States",
                    "priority": "1",
                    "billing_contact": true,
                    "job_notifications": true,
                    "email_invoices": true,
                    "client_portal": false,
                    "field_tech_show": true,
                    "channel": "sms",
                    "on_the_way": true,
                    "completed": true,
                    "off_schedule": false,
                    "marketing_allowed": 1,
                    "marketing_allowed_updated_at": "2025-03-05 10:20:55",
                    "marketing_allowed_source": "open_api"
                }
            ]
        }
    ]
}
 

Received response:

Request failed with error:

Tip: Check that you're properly connected to the network.
If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
You can check the Dev Tools console for debugging information.