List authors
GET/v1/authorsKey scope read
Lists the project's authors with their status, trust level, risk score and counters. Sort by recent activity, trust level, risk score or creation date to find the authors that need attention.
Needs a key with the read scope. Authentication
Query parameters
limitintegerDefault20Number of items to return, 1 to 100. Default 20.
cursorstringThe
next_cursorof the previous page, for a request with the samesortandorder. Omit it for the first page.statusenumReturn only authors in this status:
enabled,suspendedorblocked.One of
enabledsuspendedblockedtrust_levelenumReturn only authors whose automatic trust level is this value:
new,basic,regular,establishedortrusted. The filter reads the automatic level, so an author with atrust_overrideis matched by the level underneath it and not by thetrust_levelthe response shows.One of
newbasicregularestablishedtrustedsortenumWhat to sort by:
activity(last seen, the default),trust(automatic trust level, fromnewtotrusted),risk(risk score) orcreated(creation date). Withrisk, authors without a risk score come last in either order.One of
activitytrustriskcreatedorderenumdesc(default) orasc.One of
ascdesc
Returns
A list object: data holds up to limit authors, has_more says whether another page exists and next_cursor is the value to send as cursor, or null on the last page.
- 200 OKA list of author objects
Errors
- 400
invalid_cursorcursoris not a value returned by this endpoint.- 422
validation_errorlimitis outside 1 to 100, orstatus,trust_level,sortororderis not one of the listed values.
Every endpoint can also answer the errors any request can meet: a missing key, a rate limit, a malformed body. Errors
Something missing or unclear on this page? Write to support@useinfrared.com.