Skip to main content

Queries the members of a shared account

GET/v2/users/:id_or_email/sharedMembers

Queries the members and their access permissions of the specified shared account. The target account can be located using the shared account ID or email address. This API is reused in the self-service delegation scenario:

  • The delegator/account owner uses this API to view the list of initiated delegated members and the approval status (SharedMember.status) of each member.

Request​

Path parameters

    id_or_email stringrequired
    • id:
    • email:

Query parameters

    offset number
    limit number

    Limits the number of members returned. The maximum value is 100.

Response

    members object[]
    sendMimeType object
    email boolean
    calendar boolean
    type enum

    Member type

    • USER:
    • DEPARTMENT:
    • GROUP:

    Possible values: [USER, DEPARTMENT, GROUP]

    value string

    Member value.

    • When type is USER, the value is the user email.
    • When type is DEPARTMENT, the value is the department ID.
    • When type is GROUP, the value is the group email.
    isBlocked boolean

    Indicates whether the member is blocked.

    name string

    Name of the member. Read-only property.

    relationships enum[]

    Sharing relationship, such as LOGIN + SEND_AS / SEND_ON_BEHALF.

    Possible values: [LOGIN, SEND_AS, SEND_ON_BEHALF]

    status enum

    Shared member approval status, used for the self-service delegation scenario. For legacy data or legacy callers that do not pass this field, the business logic defaults to APPROVED to maintain online compatibility. The self-service delegation status flow: The delegator/account owner initiates the delegation (PENDING) → the delegate accepts (APPROVED) or rejects (REJECTED).

    • PENDING: Pending acceptance. After the delegator/account owner initiates the delegation, the delegate has not yet processed it.
    • APPROVED: Accepted. The delegate agrees to the delegation, and the delegation takes effect.
    • REJECTED: Rejected. The delegate rejects the delegation.
    • EXPIRED: Expired (reserved enumeration, not implemented in this release and will not be set).

    Possible values: [PENDING, APPROVED, REJECTED, EXPIRED]

    total number<int32>

Errors

400Bad Request
401

Access is unauthorized. Please check whether the correct authorization token is passed.

403

No API access permission. Please complete the relevant authorization on the application management page of the domain administrator.

404Not Found