custom objects

Every record of one custom type, newest first

Records of one custom object type, newest first, with a cursor for the next page. The type must be one this workspace defined; ask get_crm_schema or list_object_types for the names. Filters and sorts exactly like the built-in lists, on the fields the type declared indexed.

get/v1/objects/{type}

Request

  • Base URL: https://api.indraft.io
  • URL: https://api.indraft.io/v1/objects/{type}
  • Auth: HTTP bearer

Path parameters

typestring required

The key of a type this workspace defined, as given when the type was created. Canonical types are not addressed this way.

Query parameters

limitinteger

How many to return. The page bound is published in the schema call, and asking for more is refused rather than quietly truncated.

cursorstring

The opaque marker from the previous page. Store it and hand it back; do not parse it. A cursor is only ever emitted when another row really exists, so a page you were given is never empty.

updatedSincestring

Only rows changed after this instant. The incremental read: without it a service syncing a large workspace has to walk all of it every time.

lastInteractionBeforestring

Only records whose most recent interaction is older than this, including those with none at all.

includeArchivedboolean

Include archived rows. Off by default, because a list is what you are working on and history is somewhere you go deliberately.

string
OR
string[]
string
OR
string[]
sortstring

A field to order by, with a leading minus for descending. Indexed fields only, for the same reason as filter.

Response

Success

nextCursorstring required
requestIdstring required

Changes

No recorded changes to this operation across all 1 revision of this API.