Getting and using API access in MyConstruct Studio

API access lets other software, such as automation tools, reporting dashboards and AI assistants, read and update your MyConstruct data securely, without anyone clicking through the screens. This article shows how to find your API details, create an access token and use it. No coding experience is needed for the setup steps.

API access is a feature of Studio (Enterprise (Studio)), the white-label version of MyConstruct. Each Studio business has its own web address and its own API address.

Before you start

You need:

• a Studio subscription with the API enabled (the Subscription API setting), and
• a user account with API access turned on (the User API setting).

The Access Check in step 2 below confirms both. If you cannot see the API Access tab, your business may not be on Studio, or your user role may not have access to Business Details. Check with your administrator or contact support.

Your Studio API addresses

Where <your-studio> stands for your Studio name:

Note: these are patterns, not real addresses. Always use the links on your own API Access tab, because the exact address depends on your Studio URL.

1. Open the API Access Centre

1. Sign in to your Studio site.
2. In the top-right header, click SETTINGS (the gear icon), then choose Business Details.
3. Click the API Access tab. This opens the API Access Centre.

2. Access Check

In Step 1: Access Check, click Refresh API Status. You should see:

• Subscription API: Enabled
• User API: Enabled
• Access Result: Ready

If Subscription API is not enabled, contact MyConstruct support. If User API is not enabled, ask your MyConstruct administrator or contact support.

3. Test the connection

In Step 2: Test Connection, click Run API Test. You should see your API Base (your Studio API address), Ping: OK and Docs: OK. Make a note of your API Base. Your apps and automations will use it, and all resource endpoints sit under /api/v1/.

4. Choose an authentication method

Authentication is how an app proves who it is. MyConstruct supports three methods:

If you are not sure, start with a Personal Access Token.

5. Create a Personal Access Token

1. Scroll to Step 4: Personal Access Tokens (PAT).
2. Enter a Token Name that says what it is for, for example Power BI dashboard.
3. Choose a Scope:
   • Read only can view data but not change anything. Use it for reports, dashboards, backups and AI assistants that answer questions.
   • Read/write can create and update data. Use it only for trusted systems that need it.
4. Set an Expires On date. Read/write tokens must expire within 90 days. Read-only tokens can omit an expiry, but setting one is good practice.
5. Click Create Token.

The new token is shown once only. Click Copy and store it straight away in a password manager or the secure credentials field of the tool you are connecting. If you lose it, revoke it and create a new one.

Your tokens are listed below the form with their name, scope, a masked preview, expiry date and last-used date, plus a Revoke button.

6. Use your token

Send the token in an Authorization header with every request:

Authorization: Bearer YOUR_TOKEN

A quick first test is to call /api/v1/me on your API base, which returns the signed-in user. You can also open the API reference, click Authorize, paste your token and try requests from the browser. In Need More Detail? at the bottom of the API Access tab you will find:

• API Guide: authentication, errors, pagination, filtering, dates and time zones, and rate limits.
• API Reference: an interactive list of every endpoint.
• Download Postman Suite: a collection you can save as a .json file and import into Postman. Set the baseUrl variable to your API address, then add your token.
• Contact Support.

Revoking a token

Revoke a token when an integration is retired, a staff member leaves, or you think a token may have leaked. Click Revoke next to the token and confirm. The token stops working immediately, and any app using it loses access.

Keeping tokens safe

• Use Read only wherever possible.
• Set the shortest sensible expiry and rotate tokens regularly.
• Use one token per integration, so revoking one does not break the others.
• Never paste tokens into shared documents, emails, support tickets or chats, including AI chat windows.
• Revoke a token immediately if it leaks, then create a new one.
• Check Last Used regularly and revoke tokens you no longer need or do not recognise.

What you can connect

• AI assistants: a read-only token lets an assistant answer questions about jobs, quotes and estimates. Start read-only.
• Automation tools such as Zapier, Make or n8n, for example posting to a channel when a job is created.
• Reporting in Power BI or Google Sheets.
• Other systems such as your CRM, accounting or scheduling tools.
• Website enquiry forms that create opportunities automatically.
• Bulk updates, such as loading a supplier price list into inventory (needs a Read/write token).

Troubleshooting

• Access Result is not Ready: see step 2, then click Refresh API Status again.
• 401 Unauthorized or token expired: check the header is exactly Authorization: Bearer YOUR_TOKEN with no quotes or extra spaces, that you copied the whole token, and that it has not expired or been revoked. Login tokens are short-lived, so call /api/v1/auth/refresh or sign in again.
• 403 Forbidden: the token may be Read only while you are trying to change data, or your user may not have access to that feature.
• 429 Too Many Requests: the limit is 120 requests per minute. Pause, then retry with a short back-off.
• 404 or nothing connects: make sure you are using your own API host (https://api-<your-studio>.myconstruct.com), not your normal app address, and that the path includes /api/v1/.

If you report an error to support, include the request_id from the error response.

Need help?

Studio customers can use Contact Support on the API Access tab, or read more about Studio.