Q: How do I construct the base URL for the Satuit REST API?
A: Your base URL follows this format: https://www2.satuitcrm.com/{sitename}. For example, if your site is "xyzmanagers" your base URL is https://www2.satuitcrm.com/xyzmanagers. API endpoints are then appended to this base: https://www2.satuitcrm.com/xyzmanagers/api/v1/business/6997.
Q: What are ibuskey and iconkey?
A: ibuskey is the unique internal ID for a Business record. iconkey is the unique internal ID for a Contact record. If you are not using the UI, you can retrieve these IDs from the API itself — for example, by querying all businesses and reading the ibuskey values in the response.
Q: How do I retrieve all business records from the API?
A: Use the business endpoint with a wildcard filter: GET /api/v1/business?filters={"pbus.cbusiness": "%"}. The % is a wildcard that returns all records. Each page returns up to 500 records. To paginate, use the page and pagesize parameters: ?filters={"pbus.cbusiness": "%"}&page=2&pagesize=200.
Q: How do I create an API user account?
A: Go to System Admin > Security > Users > Add, and assign only the "SatuitAPI" license to the new user. This license is free and does not count against your standard user licenses. If the system prompts you to purchase a license, contact your Satuit account manager — your API user setup may need to be completed through Satuit's backend.
Q: When setting up a new integration for API credentials, what do I enter in the "Redirect URI" field?
A: You can leave the Redirect URI field blank. Just give your integration a memorable name, then save. Record the Client ID and Client Secret — you will need these to authenticate API calls.
Q: Are there rate limits on the REST and Bulk APIs?
A: Yes. Both the REST and Bulk APIs share the same rate limit, which resets monthly. Your specific limit is set based on your agreement with Satuit. To check your current usage and limit, contact Satuit Support.
Q: The Contact Creation API endpoint (POST /api/v1/contact) was working and now returns a 500 Internal Server Error. What should I do?
A: A 500 error on a previously working endpoint is typically a version or configuration issue on the server side. Contact Satuit Support with your request payload and the timestamp of the failure. Do not include live bearer tokens in support cases — tokens should be regenerated after sharing.