VocalDocscontracts 1.65.0

List the sign-ins refused for want of a Member

GET /v1/members/sign-in-attempts

PropertyValue
Operationlist_sign_in_attempts
GroupMembers
Scopemembers:read
Route classread
IdempotencyNo Idempotency-Key
AuditNot audited: A configuration read; Members are Organization data, not Call content.
Released in1.12.0
Phase 0 hostServed (the hosted api pins 1.65.0)

One entry per email whose sign-in was refused because no Member holds it, newest first, kept until approved.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the members:read scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl "$VOCAL_API/v1/members/sign-in-attempts" \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
limitqueryintegernoThe page size, 1 to 100.
cursorquerystringnoThe opaque next_cursor of the previous page; it binds the filters it was issued under.

Responses

StatusContent typeShapeError codes
200application/jsonSignInAttemptList
400application/jsonErrorEnvelopeinvalid_request, invalid_cursor
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is SignInAttemptList.

FieldTypeRequiredDescription
dataarray of SignInAttemptyesThe sign-in attempts of this page, newest first.
has_morebooleanyesTrue when a further page exists.
next_cursorstring or nullyesThe cursor of the next page, or null on the last page.
object"list"yes