UniLink API Overview (Build Apps and Automations on Top of UniLink)

The UniLink public REST API lets developers build custom integrations, automate workflows, and extend the platform beyond the dashboard.

UniLink exposes a full REST API so you can read and write data programmatically — pages, contacts, orders, analytics, and content are all accessible. Whether you are building a white-label client portal, syncing orders with a fulfillment system, or pulling analytics into a custom dashboard, the same API that powers the UniLink dashboard is available to you. Every endpoint speaks JSON and follows predictable HTTP conventions, so any language or tool that can make an HTTP request works out of the box.

What the UniLink API Does

The UniLink API is a versioned REST API. The current version is v1, and the base URL for every request is https://unilink.us/api/v1. All responses are JSON objects. Successful responses return a data key containing the requested resource or collection. Error responses return an error object with a machine-readable code and a human-readable message. HTTP status codes follow standard semantics: 200 for success, 201 for created, 4xx for client errors, 5xx for server errors.

The API supports four HTTP methods: GET to fetch resources, POST to create them, PUT to update them, and DELETE to archive them. Most list endpoints are paginated using cursor-based pagination — responses include a meta object with next_cursor and prev_cursor values. Page size defaults to 20 and can be set up to 100 per request. Filtering and sorting parameters are documented per endpoint and passed as query string parameters on GET requests and as JSON body fields on POST and PUT requests.

The API is designed for several core use cases. Agencies use it to create and manage pages in bulk for their clients. Developers build white-label analytics dashboards that pull contact and order data automatically. Automation tools like Zapier or Make use the webhook and API combination to trigger actions in external systems when UniLink events occur. Content teams sync blog and help articles to external CMS platforms. In every case the API provides consistent, authenticated access to the full UniLink data model without requiring manual dashboard interaction.

How to Get Started

1. Log in to your UniLink account at app.unilink.us and open the dashboard.
2. Go to Settings → API in the left sidebar. If you do not see the API section, your plan may not include API access — upgrade from the Billing page.
3. Click Generate API Key. Give the key a descriptive name (for example, "Zapier integration" or "Analytics dashboard") so you can identify it later.
4. Copy the key immediately — it is only shown once. Store it in your application's environment variables or a secrets manager, never in source code.
5. Make a test request: curl -H "Authorization: Bearer YOUR_KEY" https://unilink.us/api/v1/pages. A 200 response with your pages confirms the key is working.

How to Use the API

1. Include the Authorization: Bearer YOUR_KEY header on every request. Requests without this header return 401 Unauthorized.
2. Set Content-Type: application/json on POST and PUT requests. GET and DELETE requests do not require a body.
3. Read the response's HTTP status code before parsing the body. A 2xx code means success. A 4xx or 5xx code means you should read the error object to understand what went wrong.
4. For list endpoints, check meta.next_cursor in the response. If it is not null, pass it as the cursor query parameter in your next request to fetch the following page of results.
5. Respect the rate limit headers (X-RateLimit-Remaining) returned with every response. If the value reaches zero, wait until X-RateLimit-Reset before sending more requests to avoid 429 errors.

Key Settings

Get the Most Out Of the UniLink API

Cache responses wherever possible. Most page and profile data changes infrequently. Caching a GET /pages response for a few minutes dramatically reduces your request count and keeps you well inside rate limits. Use ETags or Last-Modified headers if you need to detect changes efficiently without fetching entire resources.

Use webhooks alongside the API instead of polling. Instead of calling GET /orders every minute to check for new orders, register a webhook endpoint that UniLink calls immediately when an order is created. This is faster, more reliable, and uses far fewer API requests. The webhook and REST API complement each other — webhooks push events, the REST API lets you fetch details and take actions.

Build integrations with idempotency in mind. Network failures can cause requests to time out before you receive a response, leading you to retry a write operation that already succeeded. UniLink's POST endpoints accept an Idempotency-Key header — send a unique UUID with each create request and UniLink returns the same response if the key is replayed within 24 hours, preventing duplicate records.

Monitor your API key usage regularly from Settings → API. The dashboard shows request counts per key over the last 30 days. If a key is making far more requests than expected, it may indicate a polling loop in your code that could be replaced with a webhook, or a bug causing infinite retries.

Troubleshooting

• The UniLink API base URL is https://unilink.us/api/v1 and all responses are JSON.
• Generate your API key from Settings → API in the dashboard and store it securely.
• All requests require an Authorization: Bearer YOUR_KEY header.
• Rate limits are 100/hour (Free), 1,000/hour (Pro), and 10,000/hour (Business).
• Combine the REST API with webhooks for efficient, event-driven integrations instead of polling.