Servicem8 Python API Docs | dltHub

ServiceM8 is a cloud‑based field service management platform offering a REST API for managing jobs, customers, and other business data. The REST API base URL is https://api.servicem8.com/api_1.0 and Requests can be authenticated with either an API key (X‑API‑Key header) or an OAuth 2.0 Bearer token..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Servicem8 data in under 10 minutes.

---

What data can I load from Servicem8?

Here are some of the endpoints you can load from Servicem8:

---

How do I authenticate with the Servicem8 API?

For API‑key authentication include the header X-API-Key: <your_api_key>. For OAuth, include the header Authorization: Bearer <access_token>.

1. Get your credentials

1. Log in to your ServiceM8 account.
2. Navigate to Developer > My Apps.
3. Click Create New App.
4. Choose Private App to generate an API key – copy the displayed key.
5. (Optional) Choose Public App to obtain a client ID and client secret for OAuth.
6. For OAuth, follow the authorization flow using the authorisation URL https://go.servicem8.com/oauth/authorize and exchange the temporary code at https://go.servicem8.com/oauth/access_token to receive an access token.

2. Add them to .dlt/secrets.toml

Copy
[sources.servicem8_source]
api_key = "your_api_key_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Servicem8 API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python servicem8_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline servicem8_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset servicem8_data
The duckdb destination used duckdb:/servicem8.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline servicem8_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads company and jobs from the Servicem8 API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def servicem8_source(api_key=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://api.servicem8.com/api_1.0",
            "auth": {
                "type": "api_key",
                "api_key": api_key,
            },
        },
        "resources": [
            {"name": "company", "endpoint": {"path": "company.json"}},
            {"name": "jobs", "endpoint": {"path": "jobs.json"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="servicem8_pipeline",
        destination="duckdb",
        dataset_name="servicem8_data",
    )
    load_info = pipeline.run(servicem8_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("servicem8_pipeline").dataset()
sessions_df = data.jobs.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM servicem8_data.jobs LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("servicem8_pipeline").dataset()
data.jobs.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Servicem8 data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication Errors

• 401 Unauthorized – occurs when the X-API-Key header is missing, invalid, or when an OAuth token is expired or absent. Ensure you are sending the correct header and that the token has not expired.

Rate Limiting

• 429 Too Many Requests – ServiceM8 enforces a request quota per minute. If you receive this response, back‑off for a few seconds and retry.

Pagination

• Many list endpoints (e.g., jobs.json) support pagination via query parameters page and per_page. Omit these parameters to retrieve the first page; increase page to navigate through additional results.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack