Serebro AI API Documentation

Welcome to the Serebro AI API documentation. This document provides essential information about our API, helping you integrate your applications with our powerful platform.

Introduction to Our API

Serebro AI is currently transitioning to an OAuth 2.0-based API (API 2.0), which will eventually be the sole API for all integrations. Until this migration is complete, we will have two APIs available: API 1.0 and API 2.0.

API 1.0: No new endpoints are planned for this version.

API 2.0: We recommend using the API 2.0 for all new integrations, as it will host all future endpoints and new API functionality. Not all endpoints from API 1.0 have been integrated into API 2.0 yet. To ensure uninterrupted integration, please regularly review and update your integration as new endpoints become available in the API 2.0 Docs.

API Access and Keys

What is an API Key?

An Application Programming Interface (API) key is a unique identifier used to authenticate a user, developer, or data passed via our API. It is a secret key that should be kept confidential. An authorized API key allows you to pass data between software automatically using applications like Zapier, Pabbly, Integrately, Make (formerly Integromat), API Nation, and others.

Where to Find Your API Keys

You can find your API keys within your Serebro AI account settings. Typically, they are located in the "Business Info" or "API Keys" section of your account settings, at both the Location and Agency levels.

API Rate Limits

To ensure optimal performance and stability, Serebro AI has implemented the following rate limits:

API 1.0 Rate Limits:

Burst Requests: 100 requests per 10 seconds.

Daily Limit: 200,000 requests per day.

API 2.0 Rate Limits:

Burst Limit: A maximum of 100 API requests per 10 seconds for each Marketplace app per resource (i.e., Location or Company).

Daily Limit: 200,000 API requests per day for each Marketplace app per resource (i.e., Location or Company).

To monitor your usage, you can refer to the following API response headers:

X-RateLimit-Limit-Daily: Your daily limit.

X-RateLimit-Daily-Remaining: The remaining number of requests for the day.

X-RateLimit-Interval-Milliseconds: The time interval for burst requests.

X-RateLimit-Max: The maximum request limit in the specified time interval.

X-RateLimit-Remaining: The remaining number of requests in the current time interval.

Note: All examples assume your base URLs are

• v1 (Legacy REST): https://public-api.serebro.ai/

• v2 (OAuth 2.0): https://api.serebro.ai/v2/

1. Overview

Serebro AI offers two parallel API versions to ensure backward compatibility while you migrate to our most secure, feature-rich platform:

• API v1 (Legacy REST): Stable, read-only access for existing integrations.

• API v2 (OAuth 2.0): Actively maintained—new endpoints, improved security, and robust scope management.

Be sure to monitor the changelog: all future functionality appears in v2, and endpoints will be deprecated in v1 over time .

2. Authentication & Access

2.1 API Key vs. OAuth 2.0

• API Key (v1): Simple header token (Authorization: Bearer <KEY>). Ideal for quick setups but limited in scope.

• OAuth 2.0 (v2): Industry-standard authorization with granular scopes. Requires client credentials, authorization code exchange, and token refresh flows.

2.2 Issuing & Managing Credentials

• Location-level Keys: Generate under Settings → Business Info → API Keys in your Serebro AI dashboard.

• Agency-level Keys: Available in Agency Settings → API Keys for multi-location management .

2.3 Scopes & Rate Limits

• Scopes: Define read/write access per resource (e.g., contacts:read, appointments:write).

• Rate Limits (both v1 & v2): 100 requests/10 s burst; 200 000 requests/day. Monitor via response headers:

  • X-RateLimit-Limit-Daily

  • X-RateLimit-Daily-Remaining

  • X-RateLimit-Interval-Milliseconds

  • X-RateLimit-Max

  • X-RateLimit-Remaining .

3. Core Endpoints

Below are the primary resource groups—each available in v2 with most (but not yet all) legacy v1 counterparts.

3.1 Contacts

• GET /contacts — List contacts; supports filtering by name, tag, and creation date.

• POST /contacts — Create a new contact record.

• GET /contacts/{id} — Retrieve details for a single contact.

• PUT/PATCH /contacts/{id} — Update contact fields.

• DELETE /contacts/{id} — Remove a contact.

3.2 Opportunities (Deals)

• GET /opportunities — Fetch sales pipeline deals.

• POST /opportunities — Initiate a new deal tied to a contact or account.

• PATCH /opportunities/{id} — Advance stage, update value, or close won/lost.

3.3 Appointments & Scheduling

• GET /appointments — Retrieve booked events; filter by date, service type, or staff.

• POST /appointments — Schedule a new appointment with required parameters (contact ID, service ID, staff ID, start/end).

• DELETE /appointments/{id} — Cancel an existing booking.

3.4 Workflows & Automations

• GET /workflows — List workflow definitions.

• POST /workflows/{id}/execute — Trigger a workflow run programmatically.

• GET /workflow-executions — Monitor past runs and statuses.

4. Webhooks & Custom Actions

4.1 Workflow Webhooks

Serebro AI can push real-time event data to your endpoint:

• Configurable Triggers: On contact create/update, appointment booked/canceled, workflow execution events, etc.

• Methods: HTTP POST (default) or GET with payload in JSON.

• Security: Support for custom headers, HMAC signature verification, and retry logic.

4.2 Custom Webhook Action

Within your internal automations, send outbound HTTP requests to any URL:

• Supports: GET, POST, PUT, DELETE.

• Payloads: Static JSON, form data, or dynamically generated fields.

• Credentials: Store and mask secret keys, with user-friendly rotation

5. Private Integrations & Marketplace Apps

5.1 Private Integrations

Build secure, custom two-way syncs between Serebro AI and third-party systems:

• Use Cases: Payment gateways, ERP systems, niche CRMs.

• Security: Encrypted storage of API keys and OAuth tokens.

• Onboarding: Self-service in the “Private Integrations” dashboard.

5.2 Marketplace Apps

Your integration can be listed in our Developer Marketplace:

• Trigger Types: Dynamic filters, subscription callbacks, custom webhook listeners.

• Auth Methods Supported: OAuth, API Key, Basic Auth for third-party service credentials.

6. Branded Domains & API Routing

6.1 Business-level API Domain

Assign a custom domain (e.g., api.yourbrand.com) at the agency level so all generated links, form endpoints, and webhook callbacks carry your brand identity.

6.2 Sub-account Domains

Override default domains per account for ultimate control over link branding—no code changes required.

7. Custom Payments Integration

Leverage our Payments API to connect any payment processor:

• Endpoints: Create payment intents, confirm transactions, refund flows.

• Webhooks: Listen for payment success/failure and reconcile in real time.

• Testing: Swap in a sandbox URL to validate your integration before going live .

8. Troubleshooting & Support

• Error Handling: Standard HTTP status codes; 4xx for client issues, 5xx for server errors. Response bodies include an error object with code and message.

• Monitoring: All endpoints emit rate-limit headers. Build alerting on thresholds to avoid service interruption.

• Support Channels:

  • Dev Slack: Peer Q&A and engineering office hours.

  • Bug Portal: Submit tickets for unexpected behavior.

  • Monthly Council: Roadmap previews and early feature access.Support and Troubleshooting

Serebro Technologies Inc. does not provide setup code auditing or developer consultative services for API-related topics. However, if you have completed and verified your setup and are still encountering errors, you may have found a bug. In this case, please contact our support team.

If your API key is compromised, or if you are having issues with your API key, please refer to our support documentation or contact our support team for assistance.