search

Fetch

Changed on

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.

get/v1/fetch

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/fetch
  • Auth: HTTP bearer

Query parameters

idstring required

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

Response

Successful Response

idstring required

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

type'lead' | 'account' | 'sequence_template' | 'task' required

Kind of record returned.

titlestring required

Display name of the record.

textstring required

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

urlstring nullable

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

metadataobject required

Every field the record's detail read returns.

Changes