GET
View a member
Company space User accounts only For: Administrator · Permission: members.retrieve Part of Manage members.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

memberId
string
required

Identifier of the member, meaning the membership record of the person in the company or client space, not the user identifier (27-character KSUID string).

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, user_id, pseudo, phone_number, email, is_active, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the membership record (27-character KSUID string); this is what the {member} path parameters expect.

user_id

Identifier of the user account behind the member (27-character KSUID string).

pseudo

Display name of the member in this space; unique within it, ignoring case. May be null when none was set.

phone_number

Phone number of the underlying account; null when the account has none.

email

Email address of the underlying account; null when the account has none.

is_active
boolean

Whether the member can act in this space. Deactivated members keep their record.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).