Skip to main content

MemberDto

A network membership, as seen by an API client. id is the member's user id. The inviter identity, free-form info, and persistence version are intentionally not exposed.

idstring

The member's user id

Example: 7Hb2Kp9QvL3mNx0R8tZ4
rolestring

Network membership role

Possible values: [admin, viewer]

Example: admin
statusstring

Membership status

Possible values: [active, pending, suspended]

Example: active
invited_atdate-timenullable

When the member was invited to the network, if applicable

Example: 2026-01-15T09:30:00Z
accepted_atdate-timenullable

When the member accepted their invitation, if applicable

Example: 2026-01-15T09:30:00Z
created_atdate-time

When the membership was created

Example: 2026-01-15T09:30:00Z
updated_atdate-time

When the membership was last updated

Example: 2026-01-15T09:30:00Z
user objectnullable

The member's user profile; present only when ?expand=user was requested.

idstring

Unique identifier of the user

Example: 7Hb2Kp9QvL3mNx0R8tZ4
emailstring

Email address of the user

Example: ops@example.com
display_namestringnullable

Optional display name of the user

Example: Jane Doe
statusstring

Account status

Possible values: [active, inactive, suspended]

MemberDto
{
"id": "7Hb2Kp9QvL3mNx0R8tZ4",
"role": "admin",
"status": "active",
"invited_at": "2026-01-15T09:30:00Z",
"accepted_at": "2026-01-15T09:30:00Z",
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-15T09:30:00Z",
"user": {
"id": "7Hb2Kp9QvL3mNx0R8tZ4",
"email": "ops@example.com",
"display_name": "Jane Doe",
"status": "active"
}
}