{"openapi":"3.0.3","info":{"title":"Limelink API Key API","version":"2.0.0","description":"Public machine-to-machine API reference for Organization API keys. Scoped operations list their required scope."},"servers":[{"url":"https://limelink.org","description":"Production"}],"tags":[{"name":"API Credentials"},{"name":"Core Link"},{"name":"Projects"},{"name":"Applications"},{"name":"Custom Domains"},{"name":"Links"}],"paths":{"/api/v2/api-credentials/current":{"get":{"operationId":"getCurrentApiCredential","summary":"Get the authenticated API credential context","tags":["API Credentials"],"security":[{"ApiKeyAuth":[]}],"parameters":[],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentApiCredential"}}}},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/api-credentials/current\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/core/link":{"post":{"operationId":"createCoreLinkV2","summary":"Create an API Link","tags":["Core Link"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCoreLinkV2"}}}},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request POST \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/core/link\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]}},"/api/v2/core/link/availability":{"get":{"operationId":"checkCoreLinkAvailability","summary":"Check Link suffix availability","tags":["Core Link"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:read","parameters":[{"name":"project_id","in":"query","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"dynamic_link_suffix","in":"query","required":true,"schema":{"type":"string","minLength":1}},{"name":"custom_domain_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Availability"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/core/link/availability\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/organizations/{organization_id}/projects":{"post":{"operationId":"createProject","summary":"Create a Project","tags":["Projects"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"projects:write","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProject"}}}},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request POST \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]},"get":{"operationId":"listProjects","summary":"List Projects","tags":["Projects"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"projects:read","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProjectList"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/organizations/{organization_id}/projects/name-availability":{"get":{"operationId":"checkProjectNameAvailability","summary":"Check Project name availability","tags":["Projects"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"projects:read","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_name","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":100}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NameAvailability"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/name-availability\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/organizations/{organization_id}/projects/{project_id}":{"get":{"operationId":"getProject","summary":"Get a Project","tags":["Projects"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"projects:read","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]},"patch":{"operationId":"updateProject","summary":"Update a Project","tags":["Projects"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"projects:write","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProject"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Project"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request PATCH \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]},"delete":{"operationId":"deleteProject","summary":"Delete a Project","tags":["Projects"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"projects:write","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No content."},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request DELETE \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/organizations/{organization_id}/projects/{project_id}/applications":{"post":{"operationId":"createApplication","summary":"Create an Application","tags":["Applications"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"applications:write","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApplication"}}}},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request POST \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}/applications\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]},"get":{"operationId":"listApplications","summary":"List Applications","tags":["Applications"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"applications:read","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationList"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}/applications\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/applications/{application_id}":{"get":{"operationId":"getApplication","summary":"Get an Application","tags":["Applications"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"applications:read","parameters":[{"name":"application_id","in":"path","required":true,"description":"application id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/applications/${application_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]},"patch":{"operationId":"updateApplication","summary":"Update an Application","tags":["Applications"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"applications:write","parameters":[{"name":"application_id","in":"path","required":true,"description":"application id UUID.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateApplication"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Application"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request PATCH \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/applications/${application_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]},"delete":{"operationId":"deleteApplication","summary":"Delete an Application","tags":["Applications"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"applications:write","parameters":[{"name":"application_id","in":"path","required":true,"description":"application id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No content."},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request DELETE \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/applications/${application_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/organizations/{organization_id}/projects/{project_id}/custom-domains":{"post":{"operationId":"createCustomDomain","summary":"Create a Custom Domain","tags":["Custom Domains"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"domains:write","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCustomDomain"}}}},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomain"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"},"502":{"$ref":"#/components/responses/Error502"},"503":{"$ref":"#/components/responses/Error503"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request POST \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}/custom-domains\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]},"get":{"operationId":"listCustomDomains","summary":"List Custom Domains","tags":["Custom Domains"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"domains:read","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomainList"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}/custom-domains\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/custom-domains/{custom_domain_id}":{"get":{"operationId":"getCustomDomain","summary":"Get a Custom Domain","tags":["Custom Domains"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"domains:read","parameters":[{"name":"custom_domain_id","in":"path","required":true,"description":"custom domain id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomain"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/custom-domains/${custom_domain_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]},"delete":{"operationId":"deleteCustomDomain","summary":"Delete a Custom Domain","tags":["Custom Domains"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"domains:write","parameters":[{"name":"custom_domain_id","in":"path","required":true,"description":"custom domain id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No content."},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"},"503":{"$ref":"#/components/responses/Error503"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request DELETE \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/custom-domains/${custom_domain_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/custom-domains/{custom_domain_id}/retry":{"post":{"operationId":"retryCustomDomain","summary":"Retry Custom Domain provisioning","tags":["Custom Domains"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"domains:write","parameters":[{"name":"custom_domain_id","in":"path","required":true,"description":"custom domain id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomDomain"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"},"502":{"$ref":"#/components/responses/Error502"},"503":{"$ref":"#/components/responses/Error503"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request POST \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/custom-domains/${custom_domain_id}/retry\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/organizations/{organization_id}/projects/{project_id}/links":{"post":{"operationId":"createProjectLink","summary":"Create a Default Domain Link","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:write","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLink"}}}},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request POST \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}/links\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]},"get":{"operationId":"listProjectLinks","summary":"List Project Links","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:read","parameters":[{"name":"organization_id","in":"path","required":true,"description":"organization id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"project_id","in":"path","required":true,"description":"project id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkList"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/organizations/${organization_id}/projects/${project_id}/links\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/custom-domains/{custom_domain_id}/links":{"post":{"operationId":"createCustomDomainLink","summary":"Create a Custom Domain Link","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:write","parameters":[{"name":"custom_domain_id","in":"path","required":true,"description":"custom domain id UUID.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLink"}}}},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request POST \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/custom-domains/${custom_domain_id}/links\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]},"get":{"operationId":"listCustomDomainLinks","summary":"List Custom Domain Links","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:read","parameters":[{"name":"custom_domain_id","in":"path","required":true,"description":"custom domain id UUID.","schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"cursor","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkList"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/custom-domains/${custom_domain_id}/links\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/links":{"post":{"operationId":"createUnifiedLink","summary":"Create a Link from a Project and optional Custom Domain URL","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:write","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUnifiedLink"}}}},"responses":{"201":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request POST \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/links\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]}},"/api/v2/links/resolve":{"get":{"operationId":"resolveLinkByUrl","summary":"Resolve a Link by its canonical URL","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:read","parameters":[{"name":"url","in":"query","required":true,"schema":{"type":"string","format":"uri","minLength":1,"maxLength":2048},"example":"https://go.customer.example/campaign"}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/links/resolve\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}},"/api/v2/links/{link_id}":{"get":{"operationId":"getLink","summary":"Get a Link","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:read","parameters":[{"name":"link_id","in":"path","required":true,"description":"link id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request GET \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/links/${link_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]},"patch":{"operationId":"updateLink","summary":"Update a Link","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:write","parameters":[{"name":"link_id","in":"path","required":true,"description":"link id UUID.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLink"}}}},"responses":{"200":{"description":"Successful response.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Link"}}}},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request PATCH \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/links/${link_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\"\n  --header \"Content-Type: application/json\" \\\n  --data @request.json"}]},"delete":{"operationId":"deleteLink","summary":"Delete a Link","tags":["Links"],"security":[{"ApiKeyAuth":[]}],"x-required-scope":"links:write","parameters":[{"name":"link_id","in":"path","required":true,"description":"link id UUID.","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"No content."},"400":{"$ref":"#/components/responses/Error400"},"401":{"$ref":"#/components/responses/Error401"},"403":{"$ref":"#/components/responses/Error403"},"404":{"$ref":"#/components/responses/Error404"},"409":{"$ref":"#/components/responses/Error409"}},"x-codeSamples":[{"lang":"Shell","label":"curl","source":"curl --request DELETE \\\n  --url \"${LIMELINK_BASE_URL}/api/v2/links/${link_id}\" \\\n  --header \"X-API-KEY: $LIMELINK_API_KEY\""}]}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-KEY","description":"Organization API key. Never embed it in client-side applications."}},"schemas":{"AppleInfo":{"type":"object","additionalProperties":false,"properties":{"app_name":{"type":"string","maxLength":50,"nullable":true},"app_store_id":{"type":"string","maxLength":100,"nullable":true},"app_scheme":{"type":"string","maxLength":50,"nullable":true},"app_id":{"type":"string","maxLength":100,"pattern":"^[A-Z0-9]{10}\\.[A-Za-z0-9-]+(?:\\.[A-Za-z0-9-]+)+$","nullable":true},"app_id_prefix":{"type":"string","maxLength":10,"pattern":"^[A-Z0-9]{10}$","nullable":true},"bundle_id":{"type":"string","maxLength":100,"pattern":"^[A-Za-z0-9-]+(?:\\.[A-Za-z0-9-]+)+$","nullable":true}}},"AppleInfoCreate":{"allOf":[{"$ref":"#/components/schemas/AppleInfo"}],"required":["app_name","app_scheme","bundle_id"]},"AndroidInfo":{"type":"object","additionalProperties":false,"properties":{"app_name":{"type":"string","maxLength":50,"nullable":true},"app_package_name":{"type":"string","maxLength":100,"pattern":"^[A-Za-z][A-Za-z0-9_]*(\\.[A-Za-z][A-Za-z0-9_]*)+$","nullable":true},"app_scheme":{"type":"string","maxLength":500,"nullable":true},"sha256_fingerprints":{"type":"array","minItems":1,"maxItems":10,"items":{"type":"string","maxLength":100,"pattern":"^(?:[A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}$"},"nullable":true}}},"AndroidInfoCreate":{"allOf":[{"$ref":"#/components/schemas/AndroidInfo"}],"required":["app_name","app_scheme","app_package_name"]},"NotInstalledOptions":{"type":"object","additionalProperties":false,"properties":{"not_installed_options_action":{"type":"string","maxLength":100,"nullable":true},"custom_url":{"type":"string","maxLength":500,"nullable":true}}},"AppleApplicationInfo":{"type":"object","additionalProperties":false,"properties":{"app_id":{"type":"string","maxLength":100,"nullable":true},"app_store_id":{"type":"string","maxLength":100,"nullable":true},"app_scheme":{"type":"string","maxLength":50,"nullable":true},"app_name":{"type":"string","maxLength":200,"nullable":true}}},"AndroidApplicationInfo":{"type":"object","additionalProperties":false,"properties":{"app_package_name":{"type":"string","maxLength":200,"nullable":true},"app_scheme":{"type":"string","maxLength":50,"nullable":true},"app_name":{"type":"string","maxLength":200,"nullable":true},"sha256_fingerprint":{"type":"string","maxLength":500,"nullable":true}}},"AppleAdvancedOptions":{"type":"object","additionalProperties":false,"properties":{"ipad_option":{"type":"boolean","nullable":true},"app_store_campaign_option":{"type":"boolean","nullable":true},"basic_custom_url_option":{"type":"boolean","nullable":true},"ipad_store_id":{"type":"string","maxLength":100,"nullable":true},"ipad_scheme":{"type":"string","maxLength":50,"nullable":true},"at":{"type":"string","maxLength":500,"nullable":true},"ct":{"type":"string","maxLength":500,"nullable":true},"pt":{"type":"string","maxLength":500,"nullable":true},"mt":{"type":"string","maxLength":500,"nullable":true},"ius":{"type":"string","maxLength":100,"nullable":true}}},"AndroidAdvancedOptions":{"type":"object","additionalProperties":false,"properties":{"advanced_option":{"type":"boolean","nullable":true},"version":{"type":"string","maxLength":50,"nullable":true}}},"AppleOptions":{"type":"object","additionalProperties":false,"properties":{"apple_action":{"type":"string","maxLength":100,"nullable":true},"application_id":{"type":"string","maxLength":100,"nullable":true},"request_uri":{"type":"string","nullable":true},"application_info":{"allOf":[{"$ref":"#/components/schemas/AppleApplicationInfo"}],"nullable":true},"not_installed_options":{"allOf":[{"$ref":"#/components/schemas/NotInstalledOptions"}],"nullable":true},"apple_advanced_options":{"allOf":[{"$ref":"#/components/schemas/AppleAdvancedOptions"}],"nullable":true}}},"AndroidOptions":{"type":"object","additionalProperties":false,"properties":{"android_action":{"type":"string","maxLength":100,"nullable":true},"application_id":{"type":"string","maxLength":100,"nullable":true},"request_uri":{"type":"string","nullable":true},"application_info":{"allOf":[{"$ref":"#/components/schemas/AndroidApplicationInfo"}],"nullable":true},"not_installed_options":{"allOf":[{"$ref":"#/components/schemas/NotInstalledOptions"}],"nullable":true},"android_advanced_options":{"allOf":[{"$ref":"#/components/schemas/AndroidAdvancedOptions"}],"nullable":true}}},"AdditionalOptions":{"type":"object","additionalProperties":false,"properties":{"preview_action":{"type":"boolean","nullable":true},"utm_action":{"type":"boolean","nullable":true},"preview_title":{"type":"string","maxLength":100,"nullable":true},"preview_description":{"type":"string","maxLength":200,"nullable":true},"preview_image_url":{"type":"string","maxLength":500,"nullable":true},"utm_source":{"type":"string","maxLength":500,"nullable":true},"utm_medium":{"type":"string","maxLength":200,"nullable":true},"utm_campaign":{"type":"string","maxLength":500,"nullable":true},"skip_app_preview":{"type":"boolean","nullable":true}}},"CustomDomainOwnershipValidation":{"type":"object","nullable":true,"additionalProperties":true,"description":"Cloudflare ownership verification instruction; HTTP verification is preferred when supplied.","properties":{"type":{"type":"string"},"name":{"type":"string"},"value":{"type":"string"},"http_url":{"type":"string","format":"uri"},"http_body":{"type":"string"}}},"CustomDomainSslValidationRecord":{"type":"object","additionalProperties":true,"properties":{"status":{"type":"string"},"txt_name":{"type":"string"},"txt_value":{"type":"string"},"http_url":{"type":"string","format":"uri"},"http_body":{"type":"string"}}},"CustomDomainSslValidationRecords":{"type":"object","nullable":true,"additionalProperties":false,"required":["records"],"properties":{"records":{"type":"array","items":{"$ref":"#/components/schemas/CustomDomainSslValidationRecord"}}}},"ErrorResponse":{"type":"object","required":["statusCode","message"],"properties":{"statusCode":{"type":"integer"},"message":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"error":{"type":"string"}},"example":{"statusCode":400,"message":["Validation failed"],"error":"VALIDATION_FAILED"}},"CurrentApiCredential":{"type":"object","required":["id","organization_id","key_prefix","scopes"],"properties":{"id":{"type":"string","format":"uuid","example":"77777777-7777-4777-8777-777777777777"},"organization_id":{"type":"string","format":"uuid","example":"22222222-2222-4222-8222-222222222222"},"key_prefix":{"type":"string","minLength":6,"maxLength":6,"example":"AbCd12"},"scopes":{"type":"array","items":{"type":"string","enum":["projects:read","projects:write","applications:read","applications:write","domains:read","domains:write","links:read","links:write"]}}}},"CreateCoreLinkV2":{"type":"object","required":["dynamic_link_url","dynamic_link_name","project_id"],"properties":{"dynamic_link_url":{"type":"string","format":"uri","maxLength":500,"example":"https://destination.example/path"},"dynamic_link_name":{"type":"string","maxLength":100,"example":"Campaign"},"dynamic_link_suffix":{"type":"string","minLength":1,"maxLength":100,"example":"campaign"},"apple_options":{"allOf":[{"$ref":"#/components/schemas/AppleOptions"}],"nullable":true},"android_options":{"allOf":[{"$ref":"#/components/schemas/AndroidOptions"}],"nullable":true},"additional_options":{"allOf":[{"$ref":"#/components/schemas/AdditionalOptions"}],"nullable":true},"stats_flag":{"type":"boolean","default":false},"project_id":{"type":"string","format":"uuid","example":"33333333-3333-4333-8333-333333333333"},"custom_domain_id":{"type":"string","format":"uuid","nullable":true}}},"CreateUnifiedLink":{"type":"object","required":["dynamic_link_url","dynamic_link_name","project_id"],"properties":{"dynamic_link_url":{"type":"string","format":"uri","maxLength":500,"example":"https://destination.example/path"},"dynamic_link_name":{"type":"string","maxLength":100,"example":"Campaign"},"dynamic_link_suffix":{"type":"string","minLength":1,"maxLength":100,"example":"campaign"},"apple_options":{"allOf":[{"$ref":"#/components/schemas/AppleOptions"}],"nullable":true},"android_options":{"allOf":[{"$ref":"#/components/schemas/AndroidOptions"}],"nullable":true},"additional_options":{"allOf":[{"$ref":"#/components/schemas/AdditionalOptions"}],"nullable":true},"stats_flag":{"type":"boolean","default":false},"project_id":{"type":"string","format":"uuid","example":"33333333-3333-4333-8333-333333333333"},"custom_domain_url":{"type":"string","format":"uri","example":"https://go.customer.example","nullable":true}}},"CreateLink":{"type":"object","required":["dynamic_link_url","dynamic_link_name"],"properties":{"dynamic_link_url":{"type":"string","format":"uri","maxLength":500,"example":"https://destination.example/path"},"dynamic_link_name":{"type":"string","maxLength":100,"example":"Campaign"},"dynamic_link_suffix":{"type":"string","minLength":1,"maxLength":100,"example":"campaign"},"apple_options":{"allOf":[{"$ref":"#/components/schemas/AppleOptions"}],"nullable":true},"android_options":{"allOf":[{"$ref":"#/components/schemas/AndroidOptions"}],"nullable":true},"additional_options":{"allOf":[{"$ref":"#/components/schemas/AdditionalOptions"}],"nullable":true},"stats_flag":{"type":"boolean","default":false}}},"UpdateLink":{"type":"object","properties":{"dynamic_link_url":{"type":"string","format":"uri","maxLength":500,"example":"https://destination.example/path"},"dynamic_link_name":{"type":"string","maxLength":100,"example":"Campaign"},"dynamic_link_suffix":{"type":"string","minLength":1,"maxLength":100,"example":"campaign"},"apple_options":{"allOf":[{"$ref":"#/components/schemas/AppleOptions"}],"nullable":true},"android_options":{"allOf":[{"$ref":"#/components/schemas/AndroidOptions"}],"nullable":true},"additional_options":{"allOf":[{"$ref":"#/components/schemas/AdditionalOptions"}],"nullable":true},"stats_flag":{"type":"boolean","default":false}},"minProperties":1},"CreateProject":{"type":"object","required":["project_name"],"properties":{"project_name":{"type":"string","minLength":1,"maxLength":100,"example":"Example Project"},"logo_image_id":{"type":"string","format":"uuid","nullable":true}}},"UpdateProject":{"type":"object","minProperties":1,"properties":{"project_name":{"type":"string","minLength":1,"maxLength":100},"logo_image_id":{"type":"string","format":"uuid","nullable":true}}},"CreateApplication":{"oneOf":[{"type":"object","additionalProperties":false,"required":["app_type","apple_info"],"properties":{"app_type":{"type":"string","enum":["IOS"]},"apple_info":{"$ref":"#/components/schemas/AppleInfoCreate"},"android_info":{"nullable":true,"enum":[null]}}},{"type":"object","additionalProperties":false,"required":["app_type","android_info"],"properties":{"app_type":{"type":"string","enum":["ANDROID"]},"apple_info":{"nullable":true,"enum":[null]},"android_info":{"$ref":"#/components/schemas/AndroidInfoCreate"}}},{"type":"object","additionalProperties":false,"required":["app_type"],"properties":{"app_type":{"type":"string","enum":["WEB"]},"apple_info":{"nullable":true,"enum":[null]},"android_info":{"nullable":true,"enum":[null]}}}],"example":{"app_type":"IOS","apple_info":{"app_name":"Example iOS","app_scheme":"example","bundle_id":"com.example.app","app_id_prefix":"ABCDE12345"},"android_info":null}},"UpdateApplication":{"type":"object","minProperties":1,"properties":{"app_type":{"type":"string","enum":["IOS","ANDROID","WEB"]},"apple_info":{"allOf":[{"$ref":"#/components/schemas/AppleInfo"}],"nullable":true},"android_info":{"allOf":[{"$ref":"#/components/schemas/AndroidInfo"}],"nullable":true}}},"CreateCustomDomain":{"type":"object","required":["hostname"],"properties":{"hostname":{"type":"string","minLength":1,"maxLength":253,"example":"go.customer.example"}}},"Availability":{"type":"object","required":["available"],"properties":{"available":{"type":"boolean"}},"example":{"available":true}},"NameAvailability":{"type":"object","required":["is_available"],"properties":{"is_available":{"type":"boolean"}},"example":{"is_available":true}},"Project":{"type":"object","required":["id","organization_id","created_by_user_id","project_name","logo_image_id","sub_domain","logo_image","skin_info","android_app_flag","ios_app_flag","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","format":"uuid"},"created_by_user_id":{"type":"string","format":"uuid"},"project_name":{"type":"string"},"logo_image_id":{"type":"string","format":"uuid","nullable":true},"sub_domain":{"type":"string","nullable":true},"logo_image":{"type":"object","properties":{"full_path":{"type":"string","format":"uri"}},"nullable":true},"skin_info":{"type":"object","additionalProperties":true,"nullable":true},"android_app_flag":{"type":"boolean"},"ios_app_flag":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"example":{"id":"33333333-3333-4333-8333-333333333333","organization_id":"22222222-2222-4222-8222-222222222222","created_by_user_id":"11111111-1111-4111-8111-111111111111","project_name":"Example Project","logo_image_id":null,"sub_domain":"example","logo_image":null,"skin_info":null,"android_app_flag":true,"ios_app_flag":true,"created_at":"2026-01-01T00:00:00.000Z","updated_at":"2026-01-01T00:00:00.000Z"}},"Application":{"type":"object","required":["id","project_id","app_type","apple_info","android_info","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid"},"project_id":{"type":"string","format":"uuid"},"app_type":{"type":"string","enum":["IOS","ANDROID","WEB"]},"apple_info":{"allOf":[{"$ref":"#/components/schemas/AppleInfo"}],"nullable":true},"android_info":{"allOf":[{"$ref":"#/components/schemas/AndroidInfo"}],"nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"example":{"id":"44444444-4444-4444-8444-444444444444","project_id":"33333333-3333-4333-8333-333333333333","app_type":"IOS","apple_info":{"app_name":"Example iOS","app_scheme":"example","bundle_id":"com.example.app"},"android_info":null,"created_at":"2026-01-01T00:00:00.000Z","updated_at":null}},"CustomDomain":{"type":"object","required":["id","organization_id","project_id","hostname","lifecycle_status","retry_count","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","format":"uuid"},"project_id":{"type":"string","format":"uuid"},"hostname":{"type":"string"},"lifecycle_status":{"type":"string","enum":["PENDING_PROVIDER","PENDING_DNS","PENDING_CERTIFICATE","ACTIVE","FAILED","EXPIRED","DELETING"]},"cloudflare_status":{"type":"string","nullable":true},"ssl_status":{"type":"string","nullable":true},"ownership_validation":{"$ref":"#/components/schemas/CustomDomainOwnershipValidation"},"ssl_validation_records":{"$ref":"#/components/schemas/CustomDomainSslValidationRecords"},"cname_target":{"type":"string","nullable":true},"last_error":{"type":"string","enum":["Provider operation failed."],"nullable":true},"last_checked_at":{"type":"string","format":"date-time","nullable":true},"activated_at":{"type":"string","format":"date-time","nullable":true},"expires_at":{"type":"string","format":"date-time","nullable":true},"next_retry_at":{"type":"string","format":"date-time","nullable":true},"retry_count":{"type":"integer"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"example":{"id":"55555555-5555-4555-8555-555555555555","organization_id":"22222222-2222-4222-8222-222222222222","project_id":"33333333-3333-4333-8333-333333333333","hostname":"go.customer.example","lifecycle_status":"PENDING_DNS","retry_count":0,"created_at":"2026-01-01T00:00:00.000Z","updated_at":"2026-01-01T00:00:00.000Z"}},"LinkedApplication":{"type":"object","additionalProperties":false,"required":["id","app_type","apple_info","android_info"],"properties":{"id":{"type":"string","format":"uuid"},"app_type":{"type":"string","enum":["IOS","ANDROID","WEB"]},"apple_info":{"allOf":[{"$ref":"#/components/schemas/AppleInfo"}],"nullable":true},"android_info":{"allOf":[{"$ref":"#/components/schemas/AndroidInfo"}],"nullable":true}}},"Link":{"type":"object","required":["id","organization_id","project_id","custom_domain_id","domain_type","hostname","suffix","short_url","dynamic_link_url","dynamic_link_name","apple_options","android_options","applications","additional_options","stats_flag","created_at","updated_at"],"properties":{"id":{"type":"string","format":"uuid"},"organization_id":{"type":"string","format":"uuid"},"project_id":{"type":"string","format":"uuid"},"custom_domain_id":{"type":"string","format":"uuid","nullable":true},"domain_type":{"type":"string","enum":["DEFAULT","CUSTOM"]},"hostname":{"type":"string"},"suffix":{"type":"string"},"short_url":{"type":"string","format":"uri","nullable":true},"dynamic_link_url":{"type":"string","format":"uri"},"dynamic_link_name":{"type":"string"},"apple_options":{"allOf":[{"$ref":"#/components/schemas/AppleOptions"}],"nullable":true},"android_options":{"allOf":[{"$ref":"#/components/schemas/AndroidOptions"}],"nullable":true},"applications":{"type":"object","additionalProperties":false,"required":["apple","android"],"properties":{"apple":{"allOf":[{"$ref":"#/components/schemas/LinkedApplication"}],"nullable":true},"android":{"allOf":[{"$ref":"#/components/schemas/LinkedApplication"}],"nullable":true}}},"additional_options":{"allOf":[{"$ref":"#/components/schemas/AdditionalOptions"}],"nullable":true},"stats_flag":{"type":"boolean"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"example":{"id":"66666666-6666-4666-8666-666666666666","organization_id":"22222222-2222-4222-8222-222222222222","project_id":"33333333-3333-4333-8333-333333333333","custom_domain_id":null,"domain_type":"DEFAULT","hostname":"example.limelink.org","suffix":"campaign","short_url":"https://example.limelink.org/campaign","dynamic_link_url":"https://destination.example/path","dynamic_link_name":"Campaign","apple_options":null,"android_options":null,"applications":{"apple":null,"android":null},"additional_options":null,"stats_flag":true,"created_at":"2026-01-01T00:00:00.000Z","updated_at":null}},"ProjectList":{"type":"object","required":["projects"],"properties":{"projects":{"type":"array","items":{"$ref":"#/components/schemas/Project"}}}},"ApplicationList":{"type":"object","required":["applications"],"properties":{"applications":{"type":"array","items":{"$ref":"#/components/schemas/Application"}}}},"CustomDomainList":{"type":"object","required":["custom_domains"],"properties":{"custom_domains":{"type":"array","items":{"$ref":"#/components/schemas/CustomDomain"}}}},"LinkList":{"type":"object","required":["links","next_cursor"],"properties":{"links":{"type":"array","items":{"$ref":"#/components/schemas/Link"}},"next_cursor":{"type":"string","nullable":true}}}},"responses":{"Error400":{"description":"Malformed or invalid request.","headers":{"x-request-id":{"description":"Incoming request ID echoed by the API, or a generated UUID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error401":{"description":"Missing or invalid API key.","headers":{"x-request-id":{"description":"Incoming request ID echoed by the API, or a generated UUID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error403":{"description":"Blocked Organization, missing scope, or operation forbidden.","headers":{"x-request-id":{"description":"Incoming request ID echoed by the API, or a generated UUID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error404":{"description":"Resource not found or concealed across tenants.","headers":{"x-request-id":{"description":"Incoming request ID echoed by the API, or a generated UUID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error409":{"description":"Resource state or uniqueness conflict.","headers":{"x-request-id":{"description":"Incoming request ID echoed by the API, or a generated UUID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error502":{"description":"Sanitized upstream provider failure.","headers":{"x-request-id":{"description":"Incoming request ID echoed by the API, or a generated UUID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Error503":{"description":"Required provider integration unavailable.","headers":{"x-request-id":{"description":"Incoming request ID echoed by the API, or a generated UUID.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}