Lists

Companies on a list

Each company with its status, health grade, last accounts, next deadline, latest change, unread alerts, latest KYB outcome, your reference, tags and note. Filter and sort server-side.

get/lists/{id}/items

Request

  • Base URL: https://api.companystack.co.uk
  • URL: https://api.companystack.co.uk/lists/{id}/items
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

idinteger required

Query parameters

qstring

Search name, number, reference, note and tags

status'all' | 'active' | 'at_risk' | 'closed' | 'not_found'
grade'A' | 'B' | 'C' | 'D' | 'F' | 'unscored'
tagstring
overdueboolean
signalsboolean

Add a signals summary to each item (raised count, codes, names, how many signals were checked and how many are unchecked because their source has not been loaded; highest severity with the Signals add-on). signals_included says what you get: full, names or null. While Signals is not running (none of its sources loaded) nothing is added, signals_included is null and signals_running is false.

signal'any' | 'none' | 'REGISTRATION_CLUSTER' | 'LICENCE_TO_TRADE' | 'CUSTOMER_PAYS_SLOWLY'

Only companies with any signal raised, with every signal checked and none raised (none), or with this signal raised (needs Signals, or web-app Pro/Team). 409 signals_not_running while Signals is not running.

sort'name' | 'added' | 'grade' | 'status' | 'next_deadline' | 'last_accounts' | 'latest_change' | 'ref'
order'asc' | 'desc'
limitinteger
offsetinteger

Response

Items

Changes

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