Jump to

• Request
• Response
• Examples

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

Back to Top

Response

Supported Media Types

• application/json

Default Response

A list of all Proof Lists with their metadata.

Body ()

Root Schema : Proof List Array

Type: object

Title: Proof List Array

Show Source

• proofLists: array proofLists

{
    "title":"Proof List Array",
    "type":"object",
    "properties":{
        "proofLists":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/proofList"
            }
        }
    },
    "required":[
        "proofLists"
    ]
}

Nested Schema : proofLists

Type: array

Show Source

• Array of: object Proof List
  Title: Proof List

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/proofList"
    }
}

Nested Schema : Proof List

Type: object

Title: Proof List

Show Source

• 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

{
    "title":"Proof List",
    "type":"object",
    "properties":{
        "name":{
            "description":"Proof List Name",
            "type":"string"
        },
        "description":{
            "description":"Proof List description",
            "type":"string"
        },
        "listName":{
            "description":"Profile list name for which the Proof List is associated",
            "type":"string"
        },
        "folderName":{
            "description":"Folder containing the Proof List",
            "type":"string"
        },
        "createdBy":{
            "description":"User who created the Proof List",
            "type":"string"
        },
        "createdDate":{
            "description":"Proof List creation date",
            "type":"string",
            "format":"date"
        },
        "modifiedBy":{
            "description":"User who modified the Proof List",
            "type":"string"
        },
        "modifiedDate":{
            "description":"Proof List modification date",
            "type":"string",
            "format":"date"
        }
    },
    "required":[
        "name",
        "description",
        "listName",
        "folderName",
        "createdBy",
        "createdDate",
        "modifiedBy",
        "modifiedDate"
    ]
}

Back to Top

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"
    }
  ]
}
	

Back to Top