Members

Get a workspace member

Changed on

Returns a workspace member visible to the authenticated API key. The v1 path and memberId parameter are compatibility spellings for a workspace member identifier.

get/members/{memberId}

Request

  • Base URL
    https://api.ando.so/v1
  • URL
    https://api.ando.so/v1/members/{memberId}
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Path parameters

memberIdstring required

Workspace member identifier. v1 uses the legacy memberId spelling.

Response

Workspace member details.

display_namestring nullable required

Display name.

emailstring email nullable required

Email address.

idstring required

Workspace member identifier. Deprecated: read membership_id instead.

membership_idstring required

Canonical RFC 144 workspace membership identifier.

workspace_membership_idstring required

Snake-case workspace membership identifier. Deprecated: read membership_id instead.

handlestring required

Stable workspace handle.

principal_type'user' | 'agent' required

Workspace principal type.

workspace_role'guest' | 'member' | 'admin' | 'owner' required

Canonical workspace role.

joined_atnumber required

Membership join time in epoch milliseconds.

management_kind'managed_agent' | 'connected_agent' | 'unavailable' nullable required

Agent management kind; null for human members.

role_namestring nullable required

Authorized agent role name; null for humans or unavailable roles.

profile_image_urlstring uri nullable required

Profile image URL.

titlestring nullable required

Workspace member title.

workspaceMembershipIdstring required

CamelCase workspace membership identifier. Deprecated: read membership_id instead.

Example response

{
  "id": "01jzn7e61x3a7v9h2r7t2m3q4p",
  "membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p",
  "workspace_membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p",
  "workspaceMembershipId": "01jzn7e61x3a7v9h2r7t2m3q4p"
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      response property id deprecated

    • info

      response property workspaceMembershipId deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status