Organizations API endpoints to read an organization, including its plan and billing period, and to delete an organization.
Every link belongs to an organization. The organization holds the plan, the billing period, and the team. Link domains are not set here: a link with an app uses that app's own subdomain, or a custom domain. An app that existed before subdomains keeps aplnk.to as an allowed domain, and each app saves the default for its new links. An existing link with no app keeps the shared aplnk.to domain. See Apps for the subdomain each app has, and Custom Domains for domains you own yourself.
Get an Organization
GET/organizations/{id}
Get an organization
Parameters
Name
Type
In
Description
id*
string
path
Responses
200Organization details
Field
Type
Description
id
string
name
string
slug
string
plan
string
monthly_click_limit
integer
billing_period_start
string
created_at
string
updated_at
string
401Unauthorized
Field
Type
Description
error*
object
403Forbidden. The API key is missing the org:read scope.
Field
Type
Description
error*
object
404Not found
Field
Type
Description
error*
object
Delete an Organization
DELETE/organizations/{id}
Delete an organization
Permanently deletes the organization and all of its apps, links, and click history. Requires the X-Confirmation-Name header to exactly match the organization's name.
Parameters
Name
Type
In
Description
id*
string
path
X-Confirmation-Name*
string
header
Must exactly match the organization's name.
Responses
200Deleted organization
Field
Type
Description
id
string
name
string
slug
string
plan
string
monthly_click_limit
integer
billing_period_start
string
created_at
string
updated_at
string
400The X-Confirmation-Name header is missing.
Field
Type
Description
error*
object
401Unauthorized
Field
Type
Description
error*
object
403Forbidden. The API key is missing the org:delete scope, the confirmation name does not match, or the caller lacks the org:delete permission.