Skip to content
firmus.shdocs

Every page's text, headings and title. Code samples are not indexed.

List watchlists

Your organization's watchlists for a country, with their filters, and how much of the watched-companies allowance is used.

Every watchlist of your organization for the country, oldest first, in one answer: an organization holds at most 100, so the list is not paginated. Each carries watched, the count of its numbers (the numbers themselves are list watches), its filters and its digest. allowance is the organization's, across every list: used distinct watched numbers against included, the plan's figure (5 on Free, 1 000 on Pro, 10 000 on Scale). An organization with no list answers 200 with an empty watchlists, not a 404.

Not counted as a call. Served for fr only; any other country is a 404. What the filters do is explained in watch companies.

GET/v1/{country_code}/watchlistsScope read

Parameters

ParameterInTypeRequiredExample
country_codepathstringYesfr

Request

bash
curl -H "Authorization: Bearer $FIRMUS_KEY" \
  "https://api.firmus.sh/v1/fr/watchlists"

Fields

  • watchlistsobject[]
    • []objectoptional
      • idinteger
      • namestring
      • country_codestring
      • watchedinteger
      • severity_floorstring
      • include_kindsunspecified[]
        • []unspecifiedoptional
      • exclude_kindsunspecified[]
        • []unspecifiedoptional
      • include_establishmentsboolean
      • include_bulkboolean
      • digestobject
        • frequencystring
        • recipientsunspecified[]
          • []unspecifiedoptional
        • sent_atunspecifiednullable
      • created_atstring
      • updated_atstring
  • allowanceobject
    • includedinteger
    • usedinteger

Responses

The organization's watchlists for this country, and its watched-entity allowance: distinct numbers across every list, against the plan's figure.

Try it

Calls the real API with a demo key. No account, no signup.