Documentación
superleads.mx
Documentación › Referencia de la API › Objects

Objects

Referencia de la API · ☕ 7 min de lectura
Actualizado el 19 Jun 2026

CUSTOM_OBJECTS API

Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies.

Servidor base: https://services.leadconnectorhq.com

Endpoints

GET /objects/{key}

Obtener Object Schema by key / id Retrieve Object Schema by key or Id. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Scopes requeridos: objects/schema.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - key (path, string) (requerido) — key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI. - locationId (query, string) (requerido) — location id of the sub account - fetchProperties (query, string) — Fetch Properties , Fetches all the standard / custom fields of the object when set to true

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

PUT /objects/{key}

Actualizar Object Schema By Key / Id Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Scopes requeridos: objects/schema.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - key (path, string) (requerido) — key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI.

Cuerpo de la peticion (application/json): - labels — — This is how your custom object will be displayed - description — string — Pet Objects description -locationId(requerido) — string — location id -searchableProperties` (requerido) — array — Searchable Fields: Provide the field key of your object that you want to search on, using the format (custom_object..).

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

GET /objects/{schemaKey}/records/{id}

Obtener Record By Id Allows you to get a Standard Object like business and custom object record by Id

Parametros: - Versión (header, string) (requerido) — Versión de la API - schemaKey (path, string) (requerido) — The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings. - id (path, string) (requerido) — id of the record to be updated. Available on the Record details page under the 3 dots or in the url

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

PUT /objects/{schemaKey}/records/{id}

Actualizar registro Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296

Parametros: - Versión (header, string) (requerido) — Versión de la API - schemaKey (path, string) (requerido) — The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings. - id (path, string) (requerido) — id of the record to be updated. Available on the Record details page under the 3 dots or in the url - locationId (query, string) (requerido) —

Cuerpo de la peticion (application/json): - (ver esquema en la fuente original)

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

DELETE /objects/{schemaKey}/records/{id}

Eliminar registro Delete Record By Id . Supported Objects are business and custom objects.

Parametros: - Versión (header, string) (requerido) — Versión de la API - schemaKey (path, string) (requerido) — The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings. - id (path, string) (requerido) — id of the record to be updated. Available on the Record details page under the 3 dots or in the url

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

POST /objects/{schemaKey}/records

Crear registro Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296

Scopes requeridos: objects/record.write

Parametros: - Versión (header, string) (requerido) — Versión de la API - schemaKey (path, string) (requerido) — The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.

Cuerpo de la peticion (application/json): - (ver esquema en la fuente original)

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

POST /objects/{schemaKey}/records/search

Buscar Object Records Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336

Scopes requeridos: objects/record.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - schemaKey (path, string) — custom object key

Cuerpo de la peticion (application/json): - locationId (requerido) — string — Location Id - page (requerido) — number — Page - pageLimit (requerido) — number — Page Limit - query (requerido) — string — Pass this query parameter to search using your searchable properties. For example, if you have a custom object called “Pets” and have configured “name” as a searchable property, you can pass name:Buddy to search for pets with the name “Buddy.” - searchAfter (requerido) — array

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado

GET /objects/

Obtener todos los objects for a location Get all objects for a location. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Scopes requeridos: objects/schema.readonly

Parametros: - Versión (header, string) (requerido) — Versión de la API - locationId (query, string) (requerido) — Id de sede

Respuestas: - 200 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

POST /objects/

Crear Custom Object Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Scopes requeridos: objects/schema.write

Parametros: - Versión (header, string) (requerido) — Versión de la API

Cuerpo de la peticion (application/json): - labels (requerido) — — This is what your custom object will be called. These labels will be used to display your custom object on the UI - key (requerido) — string — key that would be used to refer the Custom Object internally (lowercase + underscore_separated). 'custom_objects.' would be added as prefix by default - description — string — Pet Objects description -locationId(requerido) — string — Location Id -primaryDisplayPropertyDetails` (requerido) — — Primary property which will be displayed on the record page

Respuestas: - 201 — Respuesta exitosa - 400 — Peticion invalida - 401 — No autorizado - 422 — Entidad no procesable

Enter para abrir el primer resultado · Esc para cerrar