Retrieve Proof Lists
get
/rest/api/v1.3/lists/proofLists/records
Retrieves all Proof Lists for an account.
Request
Query Parameters
-
limit(optional): integer
limit
-
offset(optional): integer
offset
Response
Supported Media Types
- application/json
Default Response
A list of all Proof Lists with their metadata.
Nested Schema : Proof List
Type:
object
Title:
Show Source
Proof List
-
createdBy:
string
User who created the Proof List
-
createdDate:
string(date)
Proof List creation date
-
description:
string
Proof List description
-
folderName:
string
Folder containing the Proof List
-
listName:
string
Profile list name for which the Proof List is associated
-
modifiedBy:
string
User who modified the Proof List
-
modifiedDate:
string(date)
Proof List modification date
-
name:
string
Proof List Name
Examples
The following example shows how to retrieve all proof lists for an account.
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Accept | application/json |
Sample Request URL:
/rest/api/v1.3/lists/proofLists/records
Sample Response: Success
{ "proofLists": [ { "proofListName": "Proof_List", "listName": "Profile_List", "folderName": "Folder_Name", "createdBy": "API_User", "createdDate": "2020-04-28", "modifiedBy": "API_User", "modifiedDate": "2020-04-28" }, { "proofListName": "Proof_List2", "listName": "Profile_List", "folderName": "Folder_Name", "createdBy": "API_User", "createdDate": "2020-04-14", "modifiedBy": "API_User", "modifiedDate": "2020-04-14" } ], "links": [ { "rel": "self", "href": "/rest/api/v1.3/lists/proofLists/records", "method": "GET" } ] }