Get List members
Read a bounded live page of permitted members, inclusion reasons and private values. Requires businesses:read or people:read separately. fields adds SMB data columns to each Business in data: a value (with its basis and date), empty, or locked. Paid columns show values on the List's first 5 members and on Businesses this Workspace unlocked; unlock says what unlocking the rest would cost. Asking costs nothing. Membership grants no access. With paid columns, usage gives the Workspace's credits_remaining.
AuthorizationBearer <token>A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.
list_id*string^list_[0-7][0-9A-HJKMNP-TV-Z]{25}$after?string1 <= length <= 4096expected_version?integer-9007199254740991 <= value <= 9007199254740991fields?stringSMB data columns to add to each member, comma separated: column keys from list_fields, such as team, revenue, value or payroll. Free to ask for; paid columns show values on the List's first 5 members and on Businesses this Workspace unlocked.
^[a-z][a-z0-9_]{0,62}(,[a-z][a-z0-9_]{0,62})*$limit?integer1 <= value <= 10050SMB-Workspace-Id*stringuuidSuccessful authorized response.
application/json- response
data*request_id*stringusage?Credits this call used, from the same transaction as any charge. 1,000,000 credits = $1.00. Paid fields cost credits only when a value comes back that this Workspace hasn't unlocked; an unlock lasts 12 months.
curl -X GET 'https://example.com/v1/lists/string/members' \ -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "data": { "next_cursor": "string", "evaluated_at": "2019-08-24T14:15:22Z", "count": { "status": "unknown", "value": null, "as_of": null, "fewer_than": -9007199254740991 }, "members": [ { "id": "string", "subject_type": "business", "projection": "public", "summary": { "display_name": "string" }, "reason": "rule", "values": { "property1": { "value_type": "text", "value": "string" }, "property2": { "value_type": "text", "value": "string" } }, "business": { "status": "string", "website_url": "string", "city": "string", "state": "string", "naics_code": "string", "naics_title": "string", "icon_url": "http://example.com" }, "data": { "property1": { "state": "value", "value": { "low": 0, "likely": 0, "high": 0 }, "basis": "public_records", "as_of": "2019-08-24" }, "property2": { "state": "value", "value": { "low": 0, "likely": 0, "high": 0 }, "basis": "public_records", "as_of": "2019-08-24" } } } ], "list_version": -9007199254740991, "unlock": { "fields": [ "string" ], "businesses": 0, "credits": 0, "months": 12, "estimated": true } }, "request_id": "string", "usage": { "credits_charged": 0, "credits_remaining": 0, "unit": "usd_micro", "unlocked_until": "2019-08-24T14:15:22Z" }}