Skip to main content

ListMembersResponse

members object[]required
  • Array [
  • contact objectrequired

    Member contact info

    email object

    Member email

    oneOf
    null
    phone object

    Member phone

    oneOf
    null
    customer objectrequired

    Member customer info

    idstring<uuid>required

    Customer id

    Possible values: <= 2147483647 characters

    name object

    Customer name

    oneOf
    null
    picture object
    oneOf
    null
    username object

    Customer username

    oneOf
    null
    legalData objectrequired

    Member legal data

    address object
    oneOf
    null
    birthInfo object
    oneOf
    null
    countryOfResidence object
    oneOf
    null
    legalSex object

    Member legal sex, [M/F]

    oneOf
    null
    name object
    oneOf
    null
    nationality object
    oneOf
    null
    membership objectrequired

    Membership info

    memberIdstring<uuid>required

    Customer id of member

    Possible values: <= 2147483647 characters

    roleMembershipRole (string)required

    Membership type

    Possible values: [MEMBER, VIEWER, PAYER, ADMIN, OWNER]

    stateMembershipState (string)required

    Membership status

    Possible values: [ACTIVE, TERMINATED]

  • ]
  • ListMembersResponse
    {
    "members": [
    {
    "contact": {
    "email": "null",
    "phone": "null"
    },
    "customer": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "null",
    "picture": "null",
    "username": "null"
    },
    "legalData": {
    "address": "null",
    "birthInfo": "null",
    "countryOfResidence": "null",
    "legalSex": "null",
    "name": "null",
    "nationality": "null"
    },
    "membership": {
    "memberId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "role": "MEMBER",
    "state": "ACTIVE"
    }
    }
    ]
    }