Skip to main content
GET
Fetch
Load the record behind one typed id returned by GET /v1/search. Whatever kind the id names, the response has the same shape: a readable rendering plus every field that kind’s detail read returns, so a client can follow a search result without branching per endpoint. The read scope of the named kind is required.

Authorizations

Authorization
string
header
required

Bearer API key issued from Settings → Developers.

Query Parameters

id
string
required

Typed id returned by GET /v1/search, in the form <type>:<uuid>.

Response

200 - application/json

Successful Response

id
string
required

Typed id of the record, in the form <type>:<uuid>.

type
enum<string>
required

Kind of record returned.

Available options:
lead,
account,
sequence_template,
task
title
string
required

Display name of the record.

text
string
required

Readable rendering of the record, for display and search indexing.

metadata
Metadata · object
required

Every field the record's detail read returns.

url
string | null

Deep link to the record in the Topo app, when it has a page.