TIC
GEThttps://lens-api.tic.io/companies/{id}/secure-links
  • Lists the secure links your team has created to the company, newest first.
  • For each link:
    • secureLinkId;
    • when it was created (issuedAtUtc);
    • when it expires or expired (expiresAtUtc; a revoked link expired when it was revoked);
    • isActive (whether it opens now);
    • createdByUserId (null when an API key created it);
    • how it has been used: visits (how many times the report was opened), visitors (from how many addresses), lastVisitedAtUtc (when last; null when it has not been opened) and annualReportsOpened (how many times an annual report in it was opened).
  • The links themselves are not listed: a link is given once, by Create a secure link.

Authorization

x-api-keystringheaderrequired

Your API key, sent in the x-api-key header.

Path parameters

idintegerrequired

Internal company ID

format: int32

Responses

The team's secure links to the company · application/json

secureLinkIdinteger

format: int32

issuedAtUtcstring

format: date-time

expiresAtUtcstring | null

format: date-time

isActiveboolean
createdByUserIdinteger | null

format: int32

visitsinteger

format: int32

visitorsinteger

format: int32

lastVisitedAtUtcstring | null

format: date-time

annualReportsOpenedinteger

format: int32