Fetch All Profile Lists
get
/rest/api/v1.3/lists
Request
There are no request parameters for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
Nested Schema : Profile Lists
Type:
object
Title:
Show Source
Profile Lists
-
fields:
array fields
The Profile List Fields
-
folderName:
string
The name of the folder in which the Profile List exists
-
name:
string
The name of the Profile List
Nested Schema : items
Type:
Show Source
object
-
fieldName(optional):
string
The Profile List Field Name
-
fieldType(optional):
string
The Profile List Field Type
Examples
The following example shows how to retrieve all profile lists for an account.
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Accept | application/json |
Sample Request URL:
/rest/api/v1.3/lists
Sample Response: Success
[ { "name": "DemoProfileList", "folderName": "Demo", "fields": [ { "fieldName": "RIID_", "fieldType": "INTEGER" }, { "fieldName": "CREATED_SOURCE_IP_", "fieldType": "STR255" }, { "fieldName": "CUSTOMER_ID_", "fieldType": "STR255" }, { "fieldName": "EMAIL_ADDRESS_", "fieldType": "STR500" }, { "fieldName": "EMAIL_DOMAIN_", "fieldType": "STR255" }, { "fieldName": "EMAIL_ISP_", "fieldType": "STR255" }, { "fieldName": "EMAIL_FORMAT_", "fieldType": "CHAR" }, { "fieldName": "EMAIL_PERMISSION_STATUS_", "fieldType": "CHAR" }, { "fieldName": "EMAIL_DELIVERABILITY_STATUS_", "fieldType": "CHAR" }, { "fieldName": "EMAIL_PERMISSION_REASON_", "fieldType": "STR255" }, { "fieldName": "EMAIL_MD5_HASH_", "fieldType": "STR50" }, { "fieldName": "EMAIL_SHA256_HASH_", "fieldType": "STR100" }, { "fieldName": "MOBILE_NUMBER_", "fieldType": "STR50" }, { "fieldName": "MOBILE_COUNTRY_", "fieldType": "STR25" }, { "fieldName": "MOBILE_PERMISSION_STATUS_", "fieldType": "CHAR" }, { "fieldName": "MOBILE_DELIVERABILITY_STATUS_", "fieldType": "CHAR" }, { "fieldName": "MOBILE_PERMISSION_REASON_", "fieldType": "STR255" }, { "fieldName": "POSTAL_STREET_1_", "fieldType": "STR255" }, { "fieldName": "POSTAL_STREET_2_", "fieldType": "STR255" }, { "fieldName": "CITY_", "fieldType": "STR50" }, { "fieldName": "STATE_", "fieldType": "STR50" }, { "fieldName": "POSTAL_CODE_", "fieldType": "STR25" }, { "fieldName": "COUNTRY_", "fieldType": "STR50" }, { "fieldName": "POSTAL_PERMISSION_STATUS_", "fieldType": "CHAR" }, { "fieldName": "POSTAL_DELIVERABILITY_STATUS_", "fieldType": "CHAR" }, { "fieldName": "POSTAL_PERMISSION_REASON_", "fieldType": "STR255" }, { "fieldName": "CREATED_DATE_", "fieldType": "TIMESTAMP" }, { "fieldName": "MODIFIED_DATE_", "fieldType": "TIMESTAMP" } ] }, { "name": "DemoList", "folderName": "Demo", "fields": [ { "fieldName": "RIID_", "fieldType": "INTEGER" }, { "fieldName": "CREATED_SOURCE_IP_", "fieldType": "STR255" }, { "fieldName": "CUSTOMER_ID_", "fieldType": "STR255" }, { "fieldName": "EMAIL_ADDRESS_", "fieldType": "STR500" }, { "fieldName": "EMAIL_DOMAIN_", "fieldType": "STR255" }, { "fieldName": "EMAIL_ISP_", "fieldType": "STR255" }, { "fieldName": "EMAIL_FORMAT_", "fieldType": "CHAR" }, { "fieldName": "EMAIL_PERMISSION_STATUS_", "fieldType": "CHAR" }, { "fieldName": "EMAIL_DELIVERABILITY_STATUS_", "fieldType": "CHAR" }, { "fieldName": "EMAIL_PERMISSION_REASON_", "fieldType": "STR255" }, { "fieldName": "EMAIL_MD5_HASH_", "fieldType": "STR50" }, { "fieldName": "EMAIL_SHA256_HASH_", "fieldType": "STR100" }, { "fieldName": "MOBILE_NUMBER_", "fieldType": "STR50" }, { "fieldName": "MOBILE_COUNTRY_", "fieldType": "STR25" }, { "fieldName": "MOBILE_PERMISSION_STATUS_", "fieldType": "CHAR" }, { "fieldName": "MOBILE_DELIVERABILITY_STATUS_", "fieldType": "CHAR" }, { "fieldName": "MOBILE_PERMISSION_REASON_", "fieldType": "STR255" }, { "fieldName": "POSTAL_STREET_1_", "fieldType": "STR255" }, { "fieldName": "POSTAL_STREET_2_", "fieldType": "STR255" }, { "fieldName": "CITY_", "fieldType": "STR50" }, { "fieldName": "STATE_", "fieldType": "STR50" }, { "fieldName": "POSTAL_CODE_", "fieldType": "STR25" }, { "fieldName": "COUNTRY_", "fieldType": "STR50" }, { "fieldName": "POSTAL_PERMISSION_STATUS_", "fieldType": "CHAR" }, { "fieldName": "POSTAL_DELIVERABILITY_STATUS_", "fieldType": "CHAR" }, { "fieldName": "POSTAL_PERMISSION_REASON_", "fieldType": "STR255" }, { "fieldName": "CREATED_DATE_", "fieldType": "TIMESTAMP" }, { "fieldName": "MODIFIED_DATE_", "fieldType": "TIMESTAMP" }, { "fieldName": "FIRST_NAME", "fieldType": "STR100" }, { "fieldName": "LAST_NAME", "fieldType": "STR100" } ] } ]
Sample Response: Failure
{ "type": "", "title": "List not found", "errorCode": "LIST_NOT_FOUND", "detail": "Account : datateam : does not have any profile lists.", "errorDetails": [] }