---
title: "Gets a custom object by object name"
method: GET
path: "/CustomObjects/{customObjectName}"
tags: ["CustomObjects"]
---

# Gets a custom object by object name

`GET /CustomObjects/{customObjectName}`

## Request

- Base URL: `https://api.insightly.com/v3.1`
- URL: `https://api.insightly.com/v3.1/CustomObjects/{customObjectName}`
- Auth: none declared. Required headers: `Authorization`

This read only endpoint returns a custom object by name.

## Path parameters

- `customObjectName` string, required

## Headers

- `Authorization` string, required

## Response `200`

Request succeeded.

- object
  - `OBJECT_NAME` string
  - `SINGULAR_LABEL` string
  - `PLURAL_LABEL` string
  - `DESCRIPTION` string
  - `RECORD_NAME_LABEL` string
  - `RECORD_NAME_TYPE` string
  - `RECORD_NAME_DISPLAY_FORMAT` string
  - `ENABLE_NAVBAR` boolean
  - `ENABLE_WORKFLOWS` boolean
  - `CREATED_USER_ID` integer
  - `DATE_CREATED_UTC` string, date-time
  - `DATE_UPDATED_UTC` string, date-time

## Other responses

- `401`: Authentication failed.

---

[API](https://skmtc.dev/insightly/apis/insightly-api-v3-1.md) - [All operations](https://skmtc.dev/insightly/apis/insightly-api-v3-1/llms.txt) - [OpenAPI document](https://skmtc.dev/insightly/apis/insightly-api-v3-1/revisions/e7df0c3b65fb?raw)