Make a First Public API Request You Can Inspect

Begin an integration with one request whose result you can read. STEADYWRK's developer hub provides a public, read-only catalog example. It is a way to inspect a response before choosing a deeper integration.

Run the public example

Open the command in a terminal where curl is available:

curl --fail-with-body --include https://steadywrk.app/api/dispatch/index

This example does not require an API key. The curl manual documents the options: --include prints response headers as well as the body; --fail-with-body makes an HTTP error visible as a nonzero exit while retaining its response for inspection.

You can also open the catalog in your browser. Browser formatting varies; inspect the response itself rather than expecting a particular visual layout.

Read the response before building around it

Check the HTTP status and the content type. If you receive an error, save a small redacted diagnostic and the observation time. Do not paste credentials or private request details into a public issue.

For a successful response, inspect the JSON and the documentation it points to. Use the documented fields and action boundaries. The catalog response is not a work order, appointment, quote acceptance or proof that an authenticated operation will succeed.

Give each next step its own test

A useful progression is: read the public response, choose a documented operation, understand its authentication, and exercise it in an appropriate test environment. Before a write, identify the input, expected effect, failure behavior and retry rule.

Do not turn an ambiguous timeout into a blind retry of a business action. Determine whether the operation supplies a way to look up its result or safely reuse a request identifier. Consult the operation's own contract; this public catalog example does not define a universal retry policy.

Keep an integration note someone can reproduce

Record the method, public URL, observation time, status and the part of the response you used. State what you have not exercised. For this example, that includes authentication and any operation that creates or changes a record.

The checklist below helps keep those boundaries visible. Use the developer hub for the current first-request example and the available integration documentation.