Skip to content
firmus.shdocs

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

List watches

The numbers one watchlist follows, page by page.

The numbers in one list, in the order they were added. Each carries number, kind (legal_entity for a SIREN, establishment for a SIRET) and created_at, when it was added. Paginated by page like the other lists of this API: page from 1, per_page 20 by default and at most 100, values out of range clamped rather than refused, and pagination with total_count and total_pages. A list with no number answers an empty watches; a list that is not your organization's is 404 not_found.

Not counted as a call. The pagination rules are on conventions.

GET/v1/{country_code}/watchlists/{watchlist_id}/watchesScope read

Parameters

ParameterInTypeRequiredExample
country_codepathstringYesfr
watchlist_idpathintegerYes1
per_pagequeryintegerNo1

Request

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

Fields

  • watchesobject[]
    • []objectoptional
      • numberstring
      • kindstring
      • created_atstring
  • paginationobject
    • pageinteger
    • per_pageinteger
    • total_countinteger
    • total_pagesinteger

Responses

pages the numbers in the order they were added

Try it

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