Lists
Get one List's entities
Changed onReturn all entities belonging to the specified List
get/lists/{list_token}
Request
- Base URLhttps://sandbox.alloy.co/v1
- Auth
- OAuth 2Client credentialsToken URL/oauth/bearer
- or HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
recordsinteger
Number of records to retrieve
offsetinteger
Offset of retrieved records
Response
List entities
Example response
{
"status_code": 200,
"error": null,
"timestamp": 1557675468774,
"name": "Denylisted entities",
"list_token": "I-23jkr423ojdfn23jon",
"data": {
"name_first": "John",
"name_last": "Doe",
"birth_date": "1980-01-01",
"document_ssn": 123321123,
"address_line_1": "123 Fake Street",
"address_line_2": "Apt 10D",
"address_city": "Brooklyn",
"address_state": "NY",
"address_postal_code": 11221,
"address_country_code": "US",
"ip_address_v4": "192.168.1.168",
"ip_address_v6": null,
"email_address": "john.doe@gmail.com",
"phone_number": 5558031203,
"acm_party_id": 12341231,
"customer_id": 1249403039484,
"system": "bridger",
"secret_question": "what is your quest",
"secret_answer": "to seek the holy grail",
"comment": "this is a comment",
"group": "aml",
"expires_at": "2023-09-01T00:00:00.000Z"
},
"paging": {
"next": "api.alloy.co/lists/I-23jkr423ojdfn23jon?records=2&offset=4",
"previous": "api.alloy.co/lists/I-23jkr423ojdfn23jon?records=2&offset=0",
"total_records": 300,
"page_records": 20,
"offset": 20
}
}Changes
- breaking
the
/response's property type changed from no type toobjectfor status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status - info
added the optional property
//to the response with the status
- breaking