Purpose

This article provides the official location of the ReadyWorks API (v1) documentation for SaaS and on-prem deployments and explains what information you’ll find there.
 

This article does not reproduce or replace the API reference found within your ReadyWorks instance.

1) API documentation links 

You'll want to bookmark these...

ReadyWorks SaaS Environments

https://customername.readyworks.com/api/docs/v1/

• Replace customername with the customer’s ReadyWorks tenant name.

• Anyone with access to that tenant can access the docs for that tenant.

   

Traditional On-premises Deployments

https://clientreadyworksURL.com/api/docs/v1/

• Replace clientreadyworksURL with the customer’s ReadyWorks server domain/URL.

2) What you’ll find in the API documentation

When you open /api/docs/v1/, you should expect an environment-specific API reference that typically includes:

• Authentication and access

  • How requests are authenticated (headers/tokens/credentials)

  • Any prerequisites to enable API access

• Resource catalog

  • The objects you can interact with (what can be read and written)

  • Supported operations per object

• Schemas and examples

  • Request/response shapes and field definitions

  • Examples that illustrate correct payload construction

• Query mechanics

  • Filtering/search patterns

  • Pagination/limits (where supported)

• Status codes and errors

  • Error response structures and validation behavior

Use the docs to confirm “how to call the API” and “what’s supported” for the specific environment you’re working in.

3) How to use the docs to accelerate any integration

A fast, repeatable approach for new integrations:

1. Confirm your correct environment link (SaaS vs on-prem).

2. Review authentication requirements and validate a basic request.

3. Identify the resources needed for the integration (read/write scope).

4. Use schemas/examples to map fields and confirm required inputs.

5. Confirm pagination/limits and error handling so the integration is stable at scale.