KintsugiKintsugi

Archive an organization

POST/organizations/{org_id}/archive

Archive an organization, capturing a churn reason. This cascades: connections are archived, API keys deleted, and any billing subscription cancelled. notes is required when reason is OTHER. Admin or Owner only: returns 403 if your credential may read the organization but is not permitted to archive it. Returns 404 if the organization does not exist or your credential cannot access it.

Authorization

Api-KeystringRequired

Your secret API key. Include it with every request.

Headers

Api-Versiondate

Release date, as YYYY-MM-DD. Defaults to 2026-07-21.

Organization-Idstring

Target organization id (Organization-Id selector).

Connection-Idstring

Target connection id; resolves to its organization.

Entity-Idstring

Platform entity id; resolves to a connection's organization.

Entity-Sourcestring

Optional source to disambiguate an Entity-Id.

Path parameters

org_idstringRequired

The unique identifier of the organization.

Body

reasonPublicArchivalReasonEnumRequired

Why the organization is being archived.

Available options:BILLING_PRICINGONBOARDING_FRICTIONPRODUCT_FITDATA_ACCURACY_TRUSTTECHNICAL_SETUP_ISSUESRESPONSIVENESS_SUPPORTINTERNAL_CHANGESTIMING_READINESSMOVED_TO_COMPETITORNO_LONGER_NEEDEDOTHER
notesstring

Free-text detail. Required when reason is OTHER.

Response

idstringRequired

Opaque unique identifier of the organization.

organizationIdstringRequired

Owning organization id. For an organization this equals id, included so every resource on the surface carries organizationId uniformly.

namestringRequired

Display name of the organization. Empty string if unset.

statusPublicOrganizationStatusEnumRequired

Lifecycle status of the organization.

Available options:ACTIVEARCHIVED
citystringRequired

Company city. Empty string if unset.

statestringRequired

Company state. Empty string if unset.

detailsOrganizationDetails

Directory-detail fields (entity type, masked EIN, industry, primary contact, registered-state count, portfolio join date). Present only when the request passes include=details; omitted otherwise.

addressLine1stringRequired

Company street address line 1. Empty string if unset.

addressLine2stringRequired

Company street address line 2. Empty string if unset.

postalCodestringRequired

Company postal code. Empty string if unset.

countryCodestringRequired

Company ISO-3166 country code. Empty string if unset.

createdAtstringRequired

When the organization was created.

updatedAtstringRequired

When the organization was last updated, or null if never.

200

Successful Response

400

The request was invalid.

401

Authentication failed or was missing.

403

The credential is not permitted for this request.

404

The requested resource was not found.

422

The request failed validation.

500

An unexpected error prevented the request from completing.

cURL
POST /organizations/{org_id}/archive
-H "Api-Key: ***"
-H "Api-Version: 2026-07-21"
{
"reason": "BILLING_PRICING",
"notes": "Reviewed and approved."
}
Example request
https://api.trykintsugi.com/organizations/{org_id}/archive
Response
{
"id": "orgn_2mNpQr7Ls8f3k",
"organizationId": "orgn_2mNpQr7Ls8f3k",
"name": "Acme Corp",
"status": "ACTIVE",
"city": "San Francisco",
"state": "CA",
"details": {
"entityType": "C_CORPORATION",
"einMasked": "**-***6789",
"industry": "454110",
"primaryContactName": "Acme Corp",
"primaryContactEmail": "jane.doe@example.com",
"registeredStates": 1,
"clientSince": "2026-07-28T12:00:00Z"
},
"addressLine1": "123 Main St",
"addressLine2": "Suite 400",
"postalCode": "94107",
"countryCode": "US",
"createdAt": "2026-07-28T12:00:00Z",
"updatedAt": "2026-07-28T12:00:00Z"
}
Archive an organization (2026-07-21) | Kintsugi API Reference