Skip to main content
GET
/
custom-objects
/
{id}
Get a custom object
curl --request GET \
  --url https://api.tomorro.com/v2/custom-objects/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Invoices",
  "smart_fields": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Invoice Number",
      "type": "string"
    }
  ],
  "help_text": "Track all invoices related to contracts."
}

Authorizations

x-api-key
string
header
required

API key for authentication. Get your key at https://app.tomorro.com/settings/integrations?integration=api-key

Path Parameters

id
string
required

The unique identifier (UUID) of the custom object

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Custom object with smart fields

id
string
required

Unique identifier for the custom object.

Example:

"550e8400-e29b-41d4-a716-446655440000"

name
string
required

The display name of the custom object.

Example:

"Invoices"

smart_fields
object[]
required

The smart fields associated with this custom object.

Example:
[
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Invoice Number",
"type": "string"
}
]
help_text
object

Help text describing the custom object.

Example:

"Track all invoices related to contracts."