---
title: "Archive Object"
method: DELETE
path: "/objects/{object_slug}"
tags: ["Objects"]
---

# Archive Object

`DELETE /objects/{object_slug}`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/objects/{object_slug}`
- Auth: HTTP bearer

PREVIEW. This endpoint is deployed but gated: it returns 404 unless the hosted app platform is enabled for your organization. It is published here so the contract describes the whole surface, not so it can be called today.

Archive a custom object without deleting data; restore with PATCH is_archived=false. Refused (409
`formula_dependency`) while a computed field elsewhere reads it, naming every dependent the credential may see.

## Path parameters

- `object_slug` string, required

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseObjectDefinitionResponse
  - `data` ObjectDefinitionResponse, required: One custom object type in the caller's workspace.
    - `slug` string, required: Stable API slug for the object type, e.g. `invoices`.
    - `singular_noun` string, required: Display name for one record, e.g. "Invoice".
    - `plural_noun` string, required: Display name for many records, e.g. "Invoices".
    - `is_system` boolean: True for objects graph8 ships; system objects cannot be deleted.
    - `is_archived` boolean: Archived objects are hidden from listings.
    - `description` string, nullable: Customer-configured object description.
    - `icon` string, nullable: Configured graph8 icon name; null uses the default.
    - `display_attribute_slug` string, nullable: Active single-value field used to label records; null uses the default.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)