SIsilverfin
Periods

List all periods of a company

List all periods of a company. <br> <b>Required scope(s):</b> communication:read, financials:read

get/api/v4/f/{firm_id}/companies/{company_id}/periods

Request

  • Base URL
    https://live.getsilverfin.com
  • URL
    https://live.getsilverfin.com/api/v4/f/{firm_id}/companies/{company_id}/periods
  • Auth
    OAuth 2
    Authorization code: https://live.getsilverfin.com/oauth/authorize
    Token URL: https://live.getsilverfin.com/oauth/token scopes: communication:read, financials:read

Path parameters

firm_idinteger required
company_idinteger required

Query parameters

pageinteger
per_pageinteger
publicboolean

If set to true, then only the public periods will be listed in the response. If set to false, only private periods will be provided. Leave blank if you want to return all periods.

Headers

Acceptstring
Accept-Languagestring

Response

Successful response

idinteger

period_id

end_datestring
publicboolean
extra_data_headersstring[]
lockedboolean
locked_permanentlyboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.