Skip to content

GET /api/v3/objects/{id}

Summary

GET /objects/{lcuid}

Description

Get an object based on its lcuid

Helpful to determine information about an object if you only possess its lcuid

This example uses an account object. The response will vary depending on the class of the object.

🔒 Required Permissions

At least one of the following permissions is required to access this endpoint:

  • {object}.view

Tags: objects

Parameters

Header Parameters

Name Type Required Description Example
Authorization string ✓ Yes Bearer {AuthToken}
Content-Type string ✓ Yes application/json
Accept string ✓ Yes application/json
AppIdV3 string ✓ Yes LCUID-LAP-********-****-****-****-************

Responses

Response: 200

Content Type: application/json

Schema

Type: object

Properties:

  • success (boolean)
  • object_class (string)
  • object (object) Type: object

Properties:

  • name (string)
  • options (object) Type: object

    Properties:

    • primary_image_public_url (string)
    • primary_image_background_removed_public_url (string)
  • lcuid (string)

  • slug (string)
  • website (string)
  • description (string)
  • created_at (string)
  • is_parent_account (boolean)
Example Response
{
    "success": true,
    "object_class": "App\\Account",
    "object": {
        "name": "Blue River Real Estate",
        "options": {
            "primary_image_public_url": null,
            "primary_image_background_removed_public_url": null
        },
        "lcuid": "LCUID-LA-36543354-0735-46c6-a0a9-5247475b3916",
        "slug": "UnitTestAccountZs3ge",
        "website": null,
        "description": "Here is a new unit test account description",
        "created_at": "2026-01-07T00:15:42.000000Z",
        "is_parent_account": false
    }
}

Example Implementations

Bash (cURL)

curl --request GET \
  --url "https://api.lucit.app/api/v3/objects/{id}" \
  --header "Authorization: Bearer {AuthToken}" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "AppIdV3: LCUID-LAP-********-****-****-****-************"

JavaScript (Fetch API)

const url = "https://api.lucit.app/api/v3/objects/{id}";

const headers = {
  "Authorization": "Bearer {AuthToken}",
  "Content-Type": "application/json",
  "Accept": "application/json",
  "AppIdV3": "LCUID-LAP-********-****-****-****-************"
};

fetch(url, {
  method: "GET",
  headers: headers
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));

PHP (Guzzle)

<?php

require_once 'vendor/autoload.php';

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.lucit.app/api/v3/objects/{id}', [
  'headers' => [
    'Authorization' => 'Bearer {AuthToken}',
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'AppIdV3' => 'LCUID-LAP-********-****-****-****-************',
  ]
]);

$body = $response->getBody();
$data = json_decode($body, true);
print_r($data);

Python (Requests)

import requests
import json

url = "https://api.lucit.app/api/v3/objects/{id}"

headers = {
  "Authorization": "Bearer {AuthToken}",
  "Content-Type": "application/json",
  "Accept": "application/json",
  "AppIdV3": "LCUID-LAP-********-****-****-****-************"
}

response = requests.get(url, headers=headers)
print(response.json())

← Back to objects index | Back to main index