companies

List companies

List companies, newest first, with a cursor for the next page. Use this to walk the customer base; search_crm answers a keyword question and cannot enumerate. Narrow with filter, for example filter: ['owner_actor_id:eq:act_...', 'expected_close_date:isNotNull'] and sort: '-expected_close_date'; get_crm_schema lists the fields each type accepts.

get/v1/companies

Request

  • Base URL: https://api.indraft.io
  • URL: https://api.indraft.io/v1/companies
  • Auth: HTTP bearer

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

Hand this back to get the next page, or null when there is no next page. Null is the end of the list and an empty items is not: a cursor is only emitted when another row really exists.

requestIdstring required

Changes

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