commonsku API: Getting Started
Learn how to access commonsku's API, connect external applications, manage permissions, and troubleshoot common integration issues.
Whether you're looking to connect your CRM, automate a process, or exchange information between systems, this guide explains how API access works, what you'll need to get started, and where to find technical documentation.
On this page:
- What is the commonsku API?
- API access and technical support
- Getting started with the commonsku API
- Understanding API keys and permissions
- Reading the API documentation
- Sandbox and production environments
- API troubleshooting
- FAQs
- Additional resources
What is the commonsku API?
An API (Application Programming Interface) is a way for two software applications to communicate with each other.
For example, if your company uses Salesforce to manage customer information and commonsku to manage projects and orders, an API integration may allow the two systems to exchange information without manually entering the same details in both places.
Instead of switching between different applications and updating information manually, your team can build integrations to exchange data and automate supported tasks.
What can you do with the commonsku API?
Depending on the available API endpoints and your account permissions, you may be able to use the API to:
- Connect commonsku with external applications, such as a CRM or internal business system.
- Retrieve supported information from commonsku for use in another application.
- Create or update supported records through an integration.
- Automate repetitive tasks between connected systems.
- Build custom integrations that support your company's workflows.
Example: Your team receives a new customer request in an external CRM. You want to transfer the relevant information into commonsku without entering everything manually.
An API integration may help with this process, depending on the endpoints available for the records and actions involved.
Important: Not every action available in the commonsku interface is necessarily available through the API. Check the commonsku API documentation to confirm which actions are supported.
API access and technical support
commonsku offers API access to eligible customers, including smaller teams that need to build their own integrations.
The technical assistance available for setting up an integration depends on your team's license count.
| Team size | API access | Technical implementation |
|---|---|---|
| 9 or fewer licenses | Available to eligible customers | Your team or developer manages the setup and implementation |
| 10 or more licenses | Available to eligible customers | commonsku can provide technical assistance with setup and implementation |
For teams with 9 or fewer licenses: Your team is responsible for building, configuring, testing, and maintaining your API integration. commonsku provides API documentation to help you get started.
For teams with 10 or more licenses: commonsku can provide technical assistance with API setup and implementation as part of your applicable service arrangement.
If you're unsure whether API access is included with your account, contact support@commonsku.com.
What does self-managed API access mean?
Self-managed API access means your company, developer, or third-party integration partner is responsible for the technical work required to connect your systems.
This includes:
- Reviewing the API documentation.
- Determining which endpoints your integration needs.
- Writing and maintaining the integration code.
- Configuring API requests and authentication.
- Mapping information between applications.
- Testing the integration and resolving issues in your code.
- Monitoring and maintaining the integration as your business needs change.
Note: API access does not mean that commonsku will automatically build or maintain an integration with your chosen application.
Getting started with the commonsku API
Before you start, make sure you understand what information you want to exchange and which actions the API needs to perform.
Step 1 - Plan your integration
Start by identifying the workflow you want to automate.
Consider these questions:
- Which application do you want to connect to commonsku?
- What information needs to move between the applications?
- Does the integration only need to retrieve information, or will it also create or update records?
- What should cause the integration to run?
- Does the information need to move in one direction or both directions?
|
Example: You use an external CRM to manage customer requests and want to send information into commonsku. Your integration requirements might include retrieving customer information from the CRM, checking for an existing record in commonsku, creating a record if the API supports that action, and storing the corresponding IDs so both systems can reference the same record. These requirements help your developer determine which endpoints are needed. |
Step 2 - Request API access
If your team doesn't already have API access:
- Contact support@commonsku.com.
- Provide your company name and commonsku account information.
- Explain that you'd like API access to build a custom integration.
- The commonsku team can review your account's eligibility and the access required.
If API access has already been enabled for your team, you can continue to the next step.
[Back to Top]
Step 3 - Obtain your API key
An API key is a unique credential used to authenticate API requests.
Think of it as a password for your integration. It allows commonsku to recognize requests made using the credentials assigned to your account.
Your integration will need the correct API key to access the commonsku API.
If you haven't received your API key, contact commonsku Support to confirm the appropriate credential provisioning process.
Important: Keep your API key private. Do not include it in public code repositories, screenshots, or messages that can be accessed by unauthorized users.
Step 4 - Review the API documentation
Visit the official documentation:
commonsku Public API Documentation
The documentation provides the technical reference for working with the API, including available endpoints, supported request methods, authentication, and data requirements.
Use the documentation to identify which endpoints are needed for your integration.
[Back to Top]
Step 5: Configure your API requests
Once you have your API key and have identified the endpoints you need, your developer can begin configuring requests.
Every request generally involves:
- Endpoint URL: The address of the API operation you're accessing.
- HTTP method: The type of action being requested.
- Authentication: The credential used to identify your integration.
- Parameters: Additional information used to identify or filter records, when supported.
- Request body: Information sent to the API when creating or updating data, where required.
commonsku API authentication uses an API key sent in the x-api-key request header.
For example, the authentication header is structured as follows:
x-api-key: YOUR_API_KEY
Replace YOUR_API_KEY with the API key provided for your account.
Your developer must use the correct endpoint URL, method, and request format specified in the documentation.
Step 6 - Test your integration
Before using an integration in your regular business workflow, test that it behaves as expected.
We recommend:
- Start with a simple request to a documented endpoint.
- Confirm that your API key is accepted.
- Verify that your account has the permissions required for the action.
- Check that the returned information matches what you expected.
- If your integration creates or updates information, verify that the changes are correct.
- Test how your integration handles errors, missing information, and duplicate records.
Important: Requests made against a production environment may affect real account data. Avoid using live customer records for testing changes unless you've carefully assessed the impact.
Understanding API keys and permissions
What is the difference between an API key and API permissions?
An API key identifies your integration, while permissions determine what your integration is allowed to do.
Having a valid API key does not necessarily mean your account has access to every API operation.
For example, your API key might be accepted, but your account may not have permission to perform a specific action.
Read and write permissions
API operations commonly fall into two categories:
| Permission | What it means | Example |
|---|---|---|
| Read | Retrieve information without changing it | Requesting information about an existing record |
| Write | Create or modify information where supported | Updating an existing record |
Some actions may require specific permissions to be enabled for your account.
If you can successfully retrieve information but cannot create or update a record, this may be related to your account's API permissions.
What if I don't have the permissions I need?
If you receive a permission-related error:
- Confirm that you're using the correct API key.
- Make sure the endpoint supports the action you're trying to perform.
- Review the endpoint's authentication and permission requirements.
- Contact commonsku Support if you believe your account is missing the necessary permissions.
When contacting Support, include the endpoint, request method, error response, and the action you're trying to perform.
The commonsku team can review whether the required access is enabled for your account.
Note: Never send your full API key in a support request unless you're using a specifically approved secure method.
Reading the API documentation
The commonsku API documentation is the main reference for developers building custom integrations.
What is an endpoint?
An endpoint is a specific URL used to request an API operation.
Different endpoints are used for different actions or types of information.
For example, one documented endpoint might retrieve information, while another might allow changes to an existing record.
Each endpoint has its own supported methods, parameters, and response format.
Understanding HTTP methods
APIs use HTTP methods to describe the type of request being made.
| Method | What it generally does |
|---|---|
| GET | Retrieves information |
| POST | Submits information, commonly to create a record or trigger an action |
| PUT | Commonly updates or replaces information |
| PATCH | Commonly updates part of a record |
| DELETE | Removes a supported resource |
Important: These are general HTTP definitions. The methods supported by commonsku vary by endpoint. Always check the API documentation before using a method.
What is a request?
A request is the information your integration sends to an API endpoint.
A request can include authentication, parameters, and data needed for the operation.
What is a response?
A response is the information returned by the API after a request.
Depending on the operation, the response may contain:
- The requested information.
- Confirmation that an action was processed.
- A record identifier.
- An error explaining why the request couldn't be completed.
Understanding API response codes
APIs use HTTP status codes to indicate the result of a request.
|
Status code |
General meaning |
What to check |
|---|---|---|
|
200 OK |
The request was successful |
Review the returned information |
|
201 Created |
A resource was created |
Confirm the new record and its details |
|
400 Bad Request |
The request couldn't be processed as submitted |
Check required fields and request formatting |
|
401 Unauthorized |
Authentication was not accepted |
Check the API key and authentication header |
|
403 Forbidden |
The requested action is not permitted |
Check account access and permissions |
|
404 Not Found |
The requested resource or route wasn't found |
Check the URL and record identifier |
|
429 Too Many Requests |
A request limit was reached |
Review documented rate limits and retry guidance |
|
500 Internal Server Error |
The server encountered an error |
Retry appropriately and contact Support if it continues |
These are standard HTTP meanings. Not every status code is necessarily returned by every commonsku endpoint.
For endpoint-specific errors and responses, refer to the official documentation.
Sandbox and production environments
When building an integration, it's important to understand the difference between a testing environment and your live commonsku account.
What is a sandbox?
A sandbox is a separate environment used to test an integration without directly using your live production environment.
It can help developers experiment with supported API operations and validate integration behaviour.
What is production?
Production is your live commonsku environment, where your team manages actual customers, projects, orders, and other business information.
Changes made through supported write operations in production may affect real records.
Why does the correct environment matter?
Sandbox and production environments are separate.
This means you should not assume that:
- The same API key will work in both environments.
- Records created in one environment will exist in the other.
- The same permissions are enabled in both environments.
- Features being tested in a sandbox are already available in production.
| Example: If your integration works against a testing environment but fails when connected to production, verify that you're using the correct production endpoint, credentials, and permissions. |
API troubleshooting
If your integration isn't working as expected, use the following guidance to identify common problems.
1. My API key isn't working
If an API request fails during authentication:
- Confirm you're using the correct commonsku API key.
- Check for missing or extra characters when copying the key.
- Make sure the key is being sent in the
x-api-keyheader. - Confirm you're sending the request to the correct API endpoint.
- Verify that the key belongs to the account and environment you're trying to access.
If the problem continues, contact commonsku Support to review the authentication issue.
2. I'm receiving an authorization or permission error
An authorization error can occur when your integration attempts an action that hasn't been enabled for your account.
For example, an integration may be able to retrieve information but not update it.
To troubleshoot:
- Identify the endpoint and method causing the error.
- Confirm the operation is supported.
- Check the authentication details.
- Verify that the required account permissions are enabled.
If you're unsure which permissions your account has, contact commonsku Support.
3. My integration works in testing but not in production
Start by comparing the environment settings.
Check that:
- You're sending requests to the intended environment.
- You're using the correct credentials.
- The records you're referencing exist in that environment.
- The required permissions are enabled.
- The feature or endpoint is available in the environment you're using.
If an endpoint is only available as part of a beta release, it may not behave the same way in production.
4. I can't find an endpoint for the action I need
Not every commonsku feature has a corresponding public API endpoint.
If you can't find an endpoint:
- Search the API documentation.
- Review the available operations for the type of record you're working with.
- Check whether the action can be completed using another documented endpoint or supported workflow.
- If the required operation isn't documented, contact commonsku to confirm whether it's supported.
[Back to Top]
5. My request returns an error or unexpected information
Review the request and response details.
Check:
- The endpoint URL and HTTP method.
- Required parameters and fields.
- The request body format.
- Record IDs or other identifiers.
- Your account permissions.
- Any error messages returned by the API.
If you're sending information to create or update a record, confirm that your request matches the documented data structure.
6. My integration is creating duplicate records
Duplicate records can occur when an integration creates a new record each time it runs without first checking whether a corresponding record already exists.
Where the API supports it, consider using an existing record ID or another reliable identifier to match records between systems.
Your developer should also review how the integration handles retries and repeated requests.
7. My integration stopped working after previously working
If an integration was working before, review any recent changes.
For example:
- Has the authentication credential changed?
- Has your integration's configuration changed?
- Is the correct endpoint still being used?
- Has the external application changed its requirements?
- Are the necessary permissions still enabled?
- Is the request returning a new error?
Review the latest API documentation and test the affected request separately to help identify the issue.
FAQs
- What information should I include when reporting an API problem?
- Do I need to be on the Enterprise package to use the commonsku API?
- Can a team with fewer than 10 licenses use the API?
- Will commonsku build my integration for me?
- Do I need a developer to use the API?
- Where can I find the API documentation?
- Where do I get my API key?
- Can I share my API key with my developer?
- Why can I retrieve information but not update it?
- Can I use the API to connect commonsku with Salesforce, HubSpot, or another CRM?
- Can I use the API to automatically create projects or orders?
- Can I update existing records through the API?
- Can I connect more than one application using the API?
- What is the difference between an API and a webhook?
- Is the API the same as the Zapier integration?
- Does API access include a sandbox environment?
- Can I use my sandbox API key in production?
- Why is a feature available in commonsku but not through the API?
- How do I know when new API endpoints are available?
- What should I do if my integration needs an endpoint that doesn't exist?
- Can I use AI tools to help build my integration?
[Back to Top]
What information should I include when reporting an API problem?
Providing complete information helps commonsku understand the issue.
When contacting Support, include:
- Your company name and commonsku account subdomain.
- A brief explanation of the workflow you're building.
- The API endpoint and HTTP method.
- Whether you're using sandbox or production.
- The error status code and message.
- Whether the request previously worked.
- A sample request and response, with confidential information removed.
- The expected result and what actually happened.
Security reminder: Remove API keys, access tokens, passwords, and confidential customer information from examples before sharing them.
Do I need to be on the Enterprise package to use the commonsku API?
API access may be available to eligible customers outside the full Enterprise package.
| Team size | API access | Technical implementation |
|---|---|---|
| 9 or fewer licenses | Available to eligible customers | Your team or developer manages the setup and implementation |
| 10 or more licenses | Available to eligible customers | commonsku can provide technical assistance with setup and implementation |
Contact commonsku to confirm whether your current account is eligible and what options are available.
Can a team with fewer than 10 licenses use the API?
Yes, eligible teams with 9 or fewer licenses can use the commonsku API.
However, these teams are responsible for their own technical setup, implementation, testing, and maintenance.
| Team size | API access | Technical implementation |
|---|---|---|
| 9 or fewer licenses | Available to eligible customers | Your team or developer manages the setup and implementation |
| 10 or more licenses | Available to eligible customers |
commonsku can provide technical assistance with setup and implementation |
Will commonsku build my integration for me?
Teams with 9 or fewer licenses are responsible for building and maintaining their own integrations.
For teams with 10 or more licenses, commonsku can provide technical assistance with setup and implementation, depending on the applicable service arrangement.
The scope of assistance should be confirmed with your commonsku team.
Do I need a developer to use the API?
We recommend working with someone who has experience building API integrations.
Developers should understand how to make HTTP requests, work with authentication credentials, interpret API responses, and handle errors.
Where can I find the API documentation?
You can access the official documentation here:
commonsku Public API Documentation
Where do I get my API key?
Contact commonsku Support if API access has been enabled but you haven't received the credentials needed for your integration.
Can I share my API key with my developer?
You can provide the required credentials to an authorized developer responsible for your integration, using a secure sharing method.
API keys should never be made public or included in publicly accessible source code.
Why can I retrieve information but not update it?
Your account may have permission to read information but not write or modify it.
First, confirm that the endpoint supports the update operation. If it does, contact commonsku Support to verify the permissions enabled for your account.
Can I use the API to connect commonsku with Salesforce, HubSpot, or another CRM?
You may be able to build a custom integration with an external CRM or business application.
However, compatibility depends on the operations available through both systems' APIs.
Review the commonsku API documentation along with the external application's API documentation to determine whether the workflow you need is supported.
Can I use the API to automatically create projects or orders?
Yes, you can.
Check the official API documentation for the specific operation you want to perform.
Can I update existing records through the API?
Some API operations may allow records to be updated, depending on the available endpoints and your account permissions.
Refer to the documentation to confirm whether the record and update operation are supported.
Can I connect more than one application using the API?
Custom integrations can be designed to connect multiple systems, provided the required endpoints, credentials, and access are available.
Your developer is responsible for managing how information moves between those systems.
[Back to FAQs]
What is the difference between an API and a webhook?
An API allows an application to make requests to another system, such as asking for information or submitting changes.
A webhook is a way for one system to automatically notify another system when a supported event occurs.
For example:
- API: Your integration asks commonsku for information about a record.
- Webhook: commonsku sends an event notification to another system when a configured event occurs.
Depending on your workflow, you may use API requests, webhooks, or a combination of both.
Is the API the same as the Zapier integration?
No. Zapier is a separate integration tool that allows you to connect supported applications using preconfigured triggers and actions.
The commonsku API provides a more technical approach to building custom integrations.
If your workflow can be completed using an existing Zapier trigger or action, Zapier may be easier to set up. More complex or unsupported workflows may require a custom API integration.
Learn more: Getting Started with commonsku + Zapier.
Does API access include a sandbox environment?
Sandbox availability depends on your account and the access that commonsku can provide.
Contact Support to confirm whether a sandbox is available for your team.
Can I use my sandbox API key in production?
Do not assume that sandbox and production use the same credentials.
Verify the correct authentication details and endpoint URL for each environment.
Why is a feature available in commonsku but not through the API?
Some features available in the commonsku application may not have a public API endpoint.
The API documentation is the reference for supported API operations. New endpoints may be introduced as the API evolves.
How do I know when new API endpoints are available?
Review the commonsku API documentation for the current list of documented endpoints.
Because the API can change over time, we recommend referring to the documentation when building or updating your integration.
What should I do if my integration needs an endpoint that doesn't exist?
Contact commonsku Support and explain the workflow you're trying to build.
Include what you're trying to achieve, which information needs to be transferred, and the operation you believe is missing.
The commonsku team can help clarify whether an existing endpoint supports the workflow or whether the request should be considered as product feedback.
Can I use AI tools to help build my integration?
AI coding assistants may help developers understand API concepts or draft integration code.
However, AI-generated answers and code should be reviewed and tested against the official commonsku API documentation before use.
Do not share API credentials or confidential customer data with unapproved AI tools.
Additional resources
- commonsku Public API Documentation — Technical reference for available endpoints, authentication, and request requirements.
- commonsku Pricing and Packages — Information about subscription packages and available features.
- Getting Started with commonsku + Zapier — Learn about connecting commonsku with other applications through Zapier.
- commonsku Integrations — Explore available integration options.
Questions? Contact us at support@commonsku.com.