---
title: "Get a custom object by ID"
method: GET
path: "/objects/{id}"
tags: ["Objects"]
---

# Get a custom object by ID

`GET /objects/{id}`

## Request

- Base URL: `https://api.commonroom.io/api/v2`
- URL: `https://api.commonroom.io/api/v2/objects/{id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/commonroom/apis/common-room-api-v2/docs/objects/:id/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a specific custom object by its unique identifier.

## Path parameters

- `id` string, required

## Query parameters

- `cols` string

## Response `200`

OK

- CustomObjectResponse
  - `success` true, required
  - `data` ApiCustomObject, required
    - `id` string, required: Prefixed custom object ID (format `co_<number>`)
    - `name` string, required: The object's display name
    - `url` string, uri: Common Room URL for this custom object
    - `recordKey` string: External record key for this object
    - `tags` string[]: Prefixed label IDs (format `l_<number>`)
    - `customFields` object: Map of custom-field ID (format `cf_<number>`) to its typed value.

## Other responses

- `400`: Bad Request (e.g. invalid object ID or invalid parameters)
- `403`: Forbidden
- `404`: Object not found
- `429`: Rate Limited

---

[API](https://skmtc.dev/commonroom/apis/common-room-api-v2.md) - [All operations](https://skmtc.dev/commonroom/apis/common-room-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/commonroom/apis/common-room-api-v2/revisions/865d4d43dadf?raw)