• Account Management/
    Using Account Members API/
    Account Members API Overview

    Account Members API Overview

    An Account Member resource is a user that you can add to accounts using account memberships.

    Account members API is read only, and you cannot add users using this API. You must use the user_authentication_info object to create users in the authentication realm of account authentication settings. For more information on adding account members, see the adding accounts and account members section.

    The Account Members Object

    AttributeTypeDescription
    idstringThe unique identifier for the selected account member.
    typestringThe type of the object that is returned.
    namestringThe name of the account member.
    emailstringThe email address of the account member.

    Sample response

    {
      "data": {
        "id": "0ff71321-f7ae-4400-abc2-d7919a78d429",
        "type": "account_member",
        "name": "John Smith",
        "email": "john@smith.com"
      },
      "links": {
        "self": "https://api.moltin.com/v2/account-members/0ff71321-f7ae-4400-abc2-d7919a78d429"
      }
    }
    

    Filtering

    The following operators and attributes are available for filtering account members.

    OperatorDescription
    eqChecks whether the values of two operands are equal. If the values are equal, the condition is true.
    likeChecks if the operand contains the specified string. You can use wildcard characters in operand.
    AttributeTypeOperatorExample
    emailstringeq / likeeq(email,ronswanson@example.com)
    namestringeq / likelike(name,*swan*)

    Was this helpful?