Searching for Members

From Enterprise Help
This is the approved revision of this page, as well as being the most recent.
Jump to: navigation, search

Getting Started

To search for a member, you first need to know the ID of the site they belong to. Click here to get a SiteID. Once you have a SiteID, you may use it in the requests below.

Search for all members (100 record increments)

Sample Request (Using 1234567890 as SiteID)

GET https://services.fishbowl.com/api/odata/v1/1234567890/Members
Accept: application/json
Authorization: Bearer Ff3xqnrs2wIODyC_HFNmM63mm7htZakghqscg2j6McqTTajflQY_n6yv0YBk8vTF6qVOa_8jzUVLD
vxmg0ukUEGre89n8-GVmnRBNXkpObjpdM0J4IfUF69WPaPlnDZuacD32T54i6ZVJ28YCyNROUIpuWoyCs-bJusbXZuP20fk-W14Zws6bdF6L6OZCtgxe23IMujeaDyW1Rd3sBJiYdC5c3rp9NIgqPpr2ZXNFzoNvhg7y
NTBEuq5RWb_eyU-vss3BbHmkdX3K93ZPIqUN32ddUwQIFZ0oS6bisUNV8a78QaAkNlD1CNbTGE

Sample Response

{
"odata.metadata": "[https://services.fishbowl.com/API/odata/v1/1234567890/$metadata#Members https://services.fishbowl.com/API/odata/v1/1234567890/$metadata#Members]",
  "value": [
    {
      "MemberID": "36540006780",
      "SiteID": "1234567890",
      "EmailAddress": "georgewashington@fishbowl.com",
      "HardBounces": 0,
      "SoftBounces": 0,
      "Suppressed": false,
      "IsTester": false,
      "CreatedUtc": "2019-01-15T15:54:53.47Z",
      "LastUpdatedUtc": "2019-01-15T15:54:53.47Z",
      "StringFields": [
        {
          "Name": "Salutation",
          "Value": null
        },
        {
          "Name": "FirstName",
          "Value": "George"
        },
        {
          "Name": "LastName",
          "Value": "Washington"
        },
        {
          "Name": "Address",
          "Value": "44 Canal Center Plaza"
        },
        {
          "Name": "City",
          "Value": "Alexandria"
        },
        {
          "Name": "State",
          "Value": "Virgina"
        },
        {
          "Name": "Zip",
          "Value": "22314"
        },
        {
          "Name": "Country",
          "Value": null
        },
        {
          "Name": "StoreCode",
          "Value": "1"
        },
        {
          "Name": "Phone",
          "Value": null
        },
        {
          "Name": "MobilePhone",
          "Value": "7038363421"
        },
        {
          "Name": "InputSource",
          "Value": "FishbowlCloud"
        },
        {
          "Name": "Gender",
          "Value": "Male"
        },
        {
          "Name": "Frequency",
          "Value": null
        },
        {
          "Name": "Language",
          "Value": null
        },
        {
          "Name": "MaritalStatus",
          "Value": null
        },
        {
          "Name": "ServerID",
          "Value": null
        }
      ],
      "BooleanFields": [],
      "Int32Fields": [],
      "Int64Fields": [],
      "DateFields": [
        {
          "Name": "Birthdate",
          "Value": "1904-02-22T05:00:00Z"
        },
        {
          "Name": "Anniversary",
          "Value": null
        },
        {
          "Name": "JoinDate",
          "Value": "2019-01-15T15:54:50Z"
        },
        {
          "Name": "DateLastDined",
          "Value": null
        },
        {
          "Name": "SMSSignUpDate",
          "Value": null
        },
        {
          "Name": "LoyaltySignUpDate",
          "Value": null
        }
      ],
      "DecimalFields": [
        {
          "Name": "OTTotalSpend",
          "Value": null
        }
      ],
      "SubscriptionsForMember": [
        {
          "ListID": "1234567890",
          "IsSubscribed": true
        }
      ],
      "TagsForMember": []
    },
...
  ]
}

Search for the next 100 members

To search for the next 100 members, append ?$skip=100 as a query string to the URL. You may search by any increment ≤ 100.

Sample Request

GET https://services.fishbowl.com/api/odata/v1/1234567890/Members?$skip=100
Accept: application/json
Authorization: Bearer Ff3xqnrs2wIODyC_HFNmM63mm7htZakghqscg2j6McqTTajflQY_n6yv0YBk8vTF6qVOa_8jzUVLD
vxmg0ukUEGre89n8-GVmnRBNXkpObjpdM0J4IfUF69WPaPlnDZuacD32T54i6ZVJ28YCyNROUIpuWoyCs-bJusbXZuP20fk-W14Zws6bdF6L6OZCtgxe23IMujeaDyW1Rd3sBJiYdC5c3rp9NIgqPpr2ZXNFzoNvhg7y
NTBEuq5RWb_eyU-vss3BbHmkdX3K93ZPIqUN32ddUwQIFZ0oS6bisUNV8a78QaAkNlD1CNbTGE


Search for a member by MemberID

To search by for a member by their MemberID, append 36540006780L to the end of the URL. Be sure to replace the example MemberID with the actual ID you wish to filter by. Note the 'L' appended to the MemberID.

Sample Request

GET https://services.fishbowl.com/api/odata/v1/1234567890/Members(36540006780L)
Accept: application/json
Authorization: Bearer Ff3xqnrs2wIODyC_HFNmM63mm7htZakghqscg2j6McqTTajflQY_n6yv0YBk8vTF6qVOa_8jzUVLD
vxmg0ukUEGre89n8-GVmnRBNXkpObjpdM0J4IfUF69WPaPlnDZuacD32T54i6ZVJ28YCyNROUIpuWoyCs-bJusbXZuP20fk-W14Zws6bdF6L6OZCtgxe23IMujeaDyW1Rd3sBJiYdC5c3rp9NIgqPpr2ZXNFzoNvhg7y
NTBEuq5RWb_eyU-vss3BbHmkdX3K93ZPIqUN32ddUwQIFZ0oS6bisUNV8a78QaAkNlD1CNbTGE


Search for a member by Email Address

To search for a member by their email address, append ?$filter=EmailAddress eq 'georgewashington@fishbowl.com' as a query string to the URL. Be sure to replace the example email address with the actual address you wish to filter by.

Sample Request

GET https://services.fishbowl.com/api/odata/v1/1234567890/Members?$filter=EmailAddress eq 'georgewashington@fishbowl.com
Accept: application/json
Authorization: Bearer Ff3xqnrs2wIODyC_HFNmM63mm7htZakghqscg2j6McqTTajflQY_n6yv0YBk8vTF6qVOa_8jzUVLD
vxmg0ukUEGre89n8-GVmnRBNXkpObjpdM0J4IfUF69WPaPlnDZuacD32T54i6ZVJ28YCyNROUIpuWoyCs-bJusbXZuP20fk-W14Zws6bdF6L6OZCtgxe23IMujeaDyW1Rd3sBJiYdC5c3rp9NIgqPpr2ZXNFzoNvhg7y
NTBEuq5RWb_eyU-vss3BbHmkdX3K93ZPIqUN32ddUwQIFZ0oS6bisUNV8a78QaAkNlD1CNbTGE


Search for members with a MemberID greater than a speciffic number

To search for members with a MemberID greater than a specific number, append ?$filter=MemberID gt 36540006780L as a query string to the URL. Be sure to replace the example MemberID with the actual value you wish to filter by. Note the 'L' appended to the MemberID.

Sample Request

GET https://services.fishbowl.com/api/odata/v1/1234567890/Members?$filter=MemberID gt 36540006780L
Accept: application/json
Authorization: Bearer Ff3xqnrs2wIODyC_HFNmM63mm7htZakghqscg2j6McqTTajflQY_n6yv0YBk8vTF6qVOa_8jzUVLD
vxmg0ukUEGre89n8-GVmnRBNXkpObjpdM0J4IfUF69WPaPlnDZuacD32T54i6ZVJ28YCyNROUIpuWoyCs-bJusbXZuP20fk-W14Zws6bdF6L6OZCtgxe23IMujeaDyW1Rd3sBJiYdC5c3rp9NIgqPpr2ZXNFzoNvhg7y
NTBEuq5RWb_eyU-vss3BbHmkdX3K93ZPIqUN32ddUwQIFZ0oS6bisUNV8a78QaAkNlD1CNbTGE

Search for members created after a specific date

To search for members created after a specific date, append ?$filter=CreatedUtc gt datetime '2019-09-26T04:00:00.00Z' as a query string to the URL. Be sure to replace the example datetime with the actual value you wish to filter by.

Sample Request

GET https://services.fishbowl.com/api/odata/v1/1234567890/Members?$filter=CreatedUtc gt datetime'2019-09-26T04:00:00.00Z'
Accept: application/json
Authorization: Bearer Ff3xqnrs2wIODyC_HFNmM63mm7htZakghqscg2j6McqTTajflQY_n6yv0YBk8vTF6qVOa_8jzUVLD
vxmg0ukUEGre89n8-GVmnRBNXkpObjpdM0J4IfUF69WPaPlnDZuacD32T54i6ZVJ28YCyNROUIpuWoyCs-bJusbXZuP20fk-W14Zws6bdF6L6OZCtgxe23IMujeaDyW1Rd3sBJiYdC5c3rp9NIgqPpr2ZXNFzoNvhg7y
NTBEuq5RWb_eyU-vss3BbHmkdX3K93ZPIqUN32ddUwQIFZ0oS6bisUNV8a78QaAkNlD1CNbTGE


Search for members based on date last updated

To search for member records based on their last updated date, append ?$filter=LastUpdated gt datetime '2019-09-26T04:00:00.00Z' as a query string to the URL. Be sure to replace the example datetime with the actual value you wish to filter by.

Sample Request

GET https://services.fishbowl.com/api/odata/v1/1234567890/Members?$filter=LastUpdatedUtc gt datetime'2019-09-26T04:00:00.00Z'
Accept: application/json
Authorization: Bearer Ff3xqnrs2wIODyC_HFNmM63mm7htZakghqscg2j6McqTTajflQY_n6yv0YBk8vTF6qVOa_8jzUVLD
vxmg0ukUEGre89n8-GVmnRBNXkpObjpdM0J4IfUF69WPaPlnDZuacD32T54i6ZVJ28YCyNROUIpuWoyCs-bJusbXZuP20fk-W14Zws6bdF6L6OZCtgxe23IMujeaDyW1Rd3sBJiYdC5c3rp9NIgqPpr2ZXNFzoNvhg7y
NTBEuq5RWb_eyU-vss3BbHmkdX3K93ZPIqUN32ddUwQIFZ0oS6bisUNV8a78QaAkNlD1CNbTGE