LimeLink V2 Guide

This guide walks through the canonical Organization and Project workspace. Use the focused guides for field-level details.

1. Create or Open an Organization

After signing in, create an Organization if you do not have one, or open an Organization you can access. An Organization is the collaboration and tenant boundary. Its workspace provides:

• Projects
• API credentials
• Members
• Organization settings

Only resources belonging to the Organization are shown. In a blocked Organization, ordinary mutations are disabled, but an active MEMBER or ADMIN may still leave and an OWNER may still request Organization deletion. The backend remains authoritative for last-OWNER and dependency conflicts.

2. Create or Open a Project

From Projects, create a Project with a unique name and optional logo, or open an existing Project. A Project begins at Links and has its own Applications, Custom domains, Billing, and settings.

See Project Management.

3. Add Applications

Open Applications to add the iOS and Android app records needed by mobile routing. You may create multiple Applications for each platform.

See Application Management.

4. Create a Default-Domain Link

Open Links, select Create Link, and choose the LimeLink default domain. Enter the Link name, destination URL, and optional suffix. Configure Apple, Android, preview, UTM, and stats options only when needed.

Default-domain Link creation is available on Free. See Create Link.

5. Add a Custom Domain

Open Custom domains and enter an exact non-apex hostname such as go.example.com. Do not enter a URL with a protocol or path. The server normalizes lowercase, trailing dots, and IDNA, and remains authoritative for validation and availability. Follow the displayed DNS and certificate lifecycle guidance after creation.

Only an active Pro Project can create a new Custom Domain or a new Custom Domain Link. Existing resources remain visible according to backend policy.

Pro costs USD $10/month and adds Custom Domains and ad-free links. Other core capabilities remain available on Free.

6. Manage Billing

Open Billing to review the Project's current subscription and payment history.

• Free Projects can subscribe to Pro.
• Active Projects can schedule cancellation for period end.
• A scheduled active cancellation offers Keep Pro.
• Cancelled or expired Projects can Subscribe again through a new checkout.
• Past-due, paused, trialing, and unknown states provide guidance instead of unsafe billing actions.

7. Create an API Credential

Open Organization API credentials. A new secret is shown only once. For server-to-server automation, store it in a secret manager and never embed it in browser or mobile code. Native SDK setup currently accepts an API key in app configuration; use a dedicated SDK credential that is not reused by backend automation, assume it can be extracted from a shipped app, minimize logging, and rotate it after suspected exposure.

See API Integration.

8. Manage Access and Settings

Use Members for role-specific access management:

• MEMBER can view members and leave.
• ADMIN can rename the Organization, invite or remove MEMBER accounts, and leave.
• OWNER can manage roles, members, invitations, and Organization deletion.

Use Organization settings for permitted Organization changes and Project settings for the selected Project. Canonical routes and responses are ancestry-checked to prevent cross-Organization rendering.

Troubleshooting

• Refresh after a retryable loading or unavailable state.
• Check Organization blocked status if mutation controls are disabled.
• Wait for a Custom Domain to become Active before creating a Link on it.
• Treat the server response as authoritative if availability or billing state changes during submission.