Jump to

• Request
• Response
• Examples

Fetch All Profile Lists

get

/rest/api/v1.3/lists

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Profile Lists

Type: object

Title: Profile Lists

Show Source

• items(optional): array items

{
    "title":"Profile Lists",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/lists"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Profile Lists
  Title: Profile Lists

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

Nested Schema : Profile Lists

Type: object

Title: Profile Lists

Show Source

• 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

{
    "title":"Profile Lists",
    "type":"object",
    "properties":{
        "name":{
            "description":"The name of the Profile List",
            "type":"string"
        },
        "folderName":{
            "description":"The name of the folder in which the Profile List exists",
            "type":"string"
        },
        "fields":{
            "description":"The Profile List Fields",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fieldName":{
                        "type":"string",
                        "description":"The Profile List Field Name"
                    },
                    "fieldType":{
                        "type":"string",
                        "description":"The Profile List Field Type"
                    }
                }
            }
        }
    },
    "required":[
        "name",
        "folderName",
        "fields"
    ]
}

Nested Schema : fields

Type: array

The Profile List Fields

Show Source

• Array of: object items

{
    "description":"The Profile List Fields",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fieldName":{
                "type":"string",
                "description":"The Profile List Field Name"
            },
            "fieldType":{
                "type":"string",
                "description":"The Profile List Field Type"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• fieldName(optional): string
  The Profile List Field Name
• fieldType(optional): string
  The Profile List Field Type

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The Profile List Field Name"
        },
        "fieldType":{
            "type":"string",
            "description":"The Profile List Field Type"
        }
    }
}

Back to Top

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

Back to Top