Jump to

• Request
• Response
• Examples

Fetch Programs for a Profile List

get

/rest/api/v1.3/programs/lists/{listName}

Fetches all programs associated with the specified profile list. The response includes a list of all Programs associated with the Profile List, and information about the program such as the status of the program, and the program channels.

Request

Supported Media Types

• application/x-www-form-urlencoded

Path Parameters

• listName: string
  Profile list name, for which the programs should be fetched

Query Parameters

• limit: integer
  Number of programs to return in the response (defaults to 200 and cannot exceed 200)
• offset: integer
  Starts at 0 and indicates the record number for the response result set

Back to Top

Response

Supported Media Types

• application/json

Default Response

Fetches all programs for the specified Profile List name

Body ()

Root Schema : Programs

Type: object

Title: Programs

Show Source

• items(optional): array items

{
    "title":"Programs",
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/retrieve-program-response"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object program
  Title: program

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/retrieve-program-response"
    }
}

Nested Schema : program

Type: object

Title: program

Show Source

• channels(optional): array channels
  List of channels for the program
• createdBy(optional): string
  User that created the program
• createdOn(optional): string
  Creation date of the program
• folderName(optional): string
  Folder name for the program.
• id(optional): string
  ID of the program.
• listName(optional): string
  Name of the list associated with the program
• modifiedBy(optional): string
  User that last modified the program
• modifiedOn(optional): string
  Last Modified date of the program
• name(optional): string
  Name of the program.
• publishDate(optional): string
  Last Publish date of the program
• status(optional): string
  Allowed Values: [ "NOT_RUNNING", "RUNNING", "RUNNING_WITH_ERRORS" ]

  Status of the program
• unpublishDate(optional): string
  Unpublish date of the program. It is empty for a program in running state

{
    "type":"object",
    "title":"program",
    "properties":{
        "id":{
            "description":"ID of the program.",
            "type":"string"
        },
        "name":{
            "description":"Name of the program.",
            "type":"string"
        },
        "folderName":{
            "description":"Folder name for the program.",
            "type":"string"
        },
        "listName":{
            "description":"Name of the list associated with the program",
            "type":"string"
        },
        "channels":{
            "description":"List of channels for the program",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "createdOn":{
            "description":"Creation date of the program",
            "type":"string"
        },
        "createdBy":{
            "description":"User that created the program",
            "type":"string"
        },
        "modifiedOn":{
            "description":"Last Modified date of the program",
            "type":"string"
        },
        "modifiedBy":{
            "description":"User that last modified the program",
            "type":"string"
        },
        "publishDate":{
            "description":"Last Publish date of the program",
            "type":"string"
        },
        "unpublishDate":{
            "description":"Unpublish date of the program. It is empty for a program in running state",
            "type":"string"
        },
        "status":{
            "description":"Status of the program",
            "enum":[
                "NOT_RUNNING",
                "RUNNING",
                "RUNNING_WITH_ERRORS"
            ],
            "type":"string"
        }
    }
}

Nested Schema : channels

Type: array

List of channels for the program

Show Source

• Array of: string

{
    "description":"List of channels for the program",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

Use this interface to get a list of Responsys programs that are associated with a specified Profile List Name. The response includes a list of all Programs associated with the Profile List, and information about the program such as the status of the program, and the program channels.

Required request headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Content-Type	application/json

Response Notes:

Sample Response Body

{
	"programs": [{
			"id": 86292841,
			"name": "Program_Name",
			"folderName": "API_Folder",
			"listName": "Profile_List_Name",
			"channels": [],
			"createdOn": "13/05/2020",
			"createdBy": "API_Account",
			"modifiedOn": "13/05/2020",
			"modifiedBy": "API_Account",
			"status": "NOT_RUNNING",
			"links": [{
					"rel": "self",
					"href": "/rest/api/v1.3/programs/lists/Profile_List_Name",
					"method": "GET"
				},
				{
					"rel": "getAllPrograms",
					"href": "/rest/api/v1.3/programs",
					"method": "GET"
				},
				{
					"rel": "getProgramByName",
					"href": "/rest/api/v1.3/programs/Program_Name",
					"method": "GET"
				},
				{
					"rel": "updateProgramState",
					"href": "/rest/api/v1.3/programs/Program_Name",
					"method": "PATCH"
				}
			]
		},
		{
			"id": 86292921,
			"name": "Sample Program",
			"folderName": "API_Folder",
			"listName": "Profile_List_Name",
			"channels": [],
			"createdOn": "13/05/2020",
			"createdBy": "API_Account",
			"modifiedOn": "13/05/2020",
			"modifiedBy": "API_Account",
			"status": "NOT_RUNNING",
			"links": [{
					"rel": "self",
					"href": "/rest/api/v1.3/programs/lists/Profile_List_Name",
					"method": "GET"
				},
				{
					"rel": "getAllPrograms",
					"href": "/rest/api/v1.3/programs",
					"method": "GET"
				},
				{
					"rel": "getProgramByName",
					"href": "/rest/api/v1.3/programs/Sample Program",
					"method": "GET"
				},
				{
					"rel": "updateProgramState",
					"href": "/rest/api/v1.3/programs/Sample Program",
					"method": "PATCH"
				}
			]
		}
	],
	"links": [{
		"rel": "self",
		"href": "/rest/api/v1.3/programs/lists/Profile_List_Name",
		"method": "GET"
	}]
}
	

Back to Top