Skip to content
firmus.shdocs

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

Get a watchlist

One watchlist, its filters and digest, and the organization's allowance.

The list a creation answered with, by its id. The same object as in the list of watchlists, under watchlist, beside the organization's allowance. digest.sent_at is when the last digest was mailed, null until one has been. A list of another organization and an id that never existed are both 404 not_found, and cannot be told apart.

Not counted as a call. A list read right after it was written reflects the write.

GET/v1/{country_code}/watchlists/{id}Scope read

Parameters

ParameterInTypeRequiredExample
country_codepathstringYesfr
idpathintegerYes1

Request

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

Fields

  • watchlistobject
    • 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

reads one list

Try it

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