VocalDocscontracts 1.65.0

Read a Member

GET /v1/members/{member_id}

PropertyValue
Operationget_member
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)

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/mem_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY"

Parameters

NameInTypeRequiredDescription
member_idpathMemberIdyesThe id of a Member: mem_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.

Responses

StatusContent typeShapeError codes
200application/jsonMember
400application/jsonErrorEnvelopeinvalid_request
401application/jsonErrorEnvelopeunauthenticated
403application/jsonErrorEnvelopeforbidden
404application/jsonErrorEnvelopenot_found
429application/jsonErrorEnveloperate_limited
500application/jsonErrorEnvelopeinternal_error

Fields of the 200 answer

The shape is Member.

FieldTypeRequiredDescription
created_atTimestampyes
display_namestring or nullyesA display name.
emailstringyesAn email address, compared ignoring case.
idMemberIdyes
invitation_expires_atTimestamp or nullnoWhen the invitation of an invited Member lapses (1.51.0): 72 hours after the invitation or the approval that created it. Null once the Member is active or disabled, and for a Member the seed created; absent from an api before 1.51.0. After it a sign-in with the email is refused with invitation_expired.
invited_byMemberId or nullnoThe Member who invited or approved this Member (1.51.0), or null when the seed or an operator command created it; absent from an api before 1.51.0.
last_sign_in_atTimestamp or nullyesThe last sign-in, or null before the first.
object"member"yes
revisionintegeryesCounts writes to the Member; returned as the ETag and required in If-Match.
roleMemberRoleyes
statusMemberStatusyes
updated_atTimestampyes