Skip to Content
API access is available to organizations with a signed BAA. Request API access →
API referenceThe Member object

The Member object

People in an organization on your account, and who manages each membership. Account API keys only.

Attributes

idUUIDRequired

The person’s BloomText user ID.

org_idUUIDRequired
emailstringRequired
first_namestringRequired
last_namestringRequired
roleadmin, userRequired

The role in this organization.

account_roleowner, it, nullRequired

Owner or IT on the account, set only in BloomText.

managed_byadmin, api, accountRequired

Who changes this membership: people in BloomText, an API key, or the account (an Owner or IT person’s membership in every organization).

managed_by_namestring or nullRequired

The API key’s name when managed_by is api.

Endpoints

MethodPathEndpoint
GET/membersList members
POST/membersAdd a member
GET/members/{memberId}Retrieve a member
PATCH/members/{memberId}Update a member
DELETE/members/{memberId}Remove a member
Last updated on