Read a Member
GET /v1/members/{member_id}
Property Value Operation get_memberGroup Members Scope members:readRoute class readIdempotency No Idempotency-Key Audit Not audited: A configuration read; Members are Organization data, not Call content. Released in 1.12.0 Phase 0 host Served (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 Node.js Python
curl "$VOCAL_API/v1/members/mem_..." \
-H "Authorization: Bearer $VOCAL_API_KEY"const response = await fetch(`${process.env.VOCAL_API}/v1/members/mem_...`, {
headers: {
Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
},
});
console.log(response.status, await response.text());import os
import requests
response = requests.get(
f"{os.environ['VOCAL_API']}/v1/members/mem_...",
headers={
"Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
},
)
print(response.status_code, response.text)
Parameters
Name In Type Required Description member_idpath MemberId yes The id of a Member: mem_ and the row's UUIDv7 in 26 Crockford base32 characters. Opaque and safe to log.
Responses
Fields of the 200 answer
The shape is Member .
Field Type Required Description created_atTimestamp yes display_namestring or null yes A display name. emailstring yes An email address, compared ignoring case. idMemberId yes invitation_expires_atTimestamp or nullno When 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 nullno The 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 nullyes The last sign-in, or null before the first. object"member"yes revisioninteger yes Counts writes to the Member; returned as the ETag and required in If-Match. roleMemberRole yes statusMemberStatus yes updated_atTimestamp yes