Contents x
    /membership/getByEmail
    • 1 Minute to read
    • Print
    • Dark
      Light
    Contents

    /membership/getByEmail

    • 1 Minute to read
    • Print
    • Dark
      Light
    Article summary

    Get
    /membership/getByEmail

    Retrieves the membership information of a contact identified by email in a group specified by groupId.

    Query parameters
    email
    stringRequired

    Email of the user.

    groupId
    integer (int64) Required

    ID of the group.

    Responses
    200

    Example response:

    {
    "userId": 18223800009,
    "groupId": 1800190005,
    "attributes": [{
    "name": "member.bounceCounter",
    "value": "0"
    }, {
    "name": "member.type",
    "value": "normal"
    }, {
    "name": "member.readMode",
    "value": "mail"
    }, {
    "name": "member.creationDate",
    "value": "2015-07-21 16:10:30.0"
    }, {
    "name": "member.bounced",
    "value": "false"
    }, {
    "name": "member.role",
    "value": "member"
    }, {
    "name": "member.messageCounter",
    "value": "0"
    }, {
    "name": "member.systemWideDeactivated",
    "value": "false"
    }]
    }

    Expand All
    object
    userId
    integer (int64)
    groupId
    integer (int64)
    attributes
    Array of object (Attribute)
    object
    name
    string
    value
    string
    400

    Bad email or group, for example:

    {
      "errorActor": "CLIENT",
      "errorCode": "NO_SUCH_OBJECT",
      "message": "User with email=no.email@example.com does not exist.",
      "objectType": "User",
      "propertyName": "email",
      "propertyValue": "no.email@example.com"
    }


    Correct email, but that contact is not a member of the specified group:

    {
      "errorActor": "CLIENT",
      "errorCode": "NO_SUCH_OBJECT",
      "message": "Membership with membership=userId:18152367016/groupId:2400792595 does not exist.",
      "objectType": "Membership",
      "propertyName": "membership",
      "propertyValue": "userId:18152367016/groupId:2400792595"
    }

    Was this article helpful?
    What's Next