The unique identifier of the category that the list belongs to
displayFormat
string
No
—
Whether we display code or value first
isManaged
boolean
No
—
Boolean indicating if the list is managed and list modifications can be made from this partner app id only
searchCriteria
string
No
—
What attribute to search by
value
string
Yes
—
Name of the list
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "categoryId": { "type": "string", "description": "The unique identifier of the category that the list belongs to" }, "displayFormat": { "type": "string", "description": "Whether we display code or value first", "enum": [ "(CODE) TEXT", "TEXT (CODE)" ] }, "isManaged": { "type": "boolean", "description": "Boolean indicating if the list is managed and list modifications can be made from this partner app id only" }, "searchCriteria": { "type": "string", "description": "What attribute to search by", "enum": [ "TEXT", "CODE" ] }, "value": { "type": "string", "description": "Name of the list" } }, "required": [ "PCID", "value" ]}
Filter capabilities for Category Type. Supports the equals and not equals operators.
isDeleted
boolean
No
—
Filter capabilities to show deleted lists. Supports the equals operator.
levelCount
string
No
—
Filter capabilities for Level Count. Supports the equals, less than, less than or equal to, greater than, greater than or equal to operators.
sortBy
string
No
—
Field to sort by, {name, levelcount, listcategory}
sortDirection
string
No
—
Sort direction, {asc, desc}
page
integer
No
—
Page number starting from 1
value
string
No
—
Filter capabilities for Value. Supports the following operators: equals, starts with, ends with, not equals, and contains pattern. Filtering is case-sensitive.
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "category.type": { "type": "string", "description": "Filter capabilities for Category Type. Supports the equals and not equals operators." }, "isDeleted": { "type": "boolean", "description": "Filter capabilities to show deleted lists. Supports the equals operator." }, "levelCount": { "type": "string", "description": "Filter capabilities for Level Count. Supports the equals, less than, less than or equal to, greater than, greater than or equal to operators." }, "sortBy": { "type": "string", "description": "Field to sort by, {name, levelcount, listcategory}", "enum": [ "name", "levelcount", "listcategory" ] }, "sortDirection": { "type": "string", "description": "Sort direction, {asc, desc}", "enum": [ "asc", "desc" ] }, "page": { "type": "integer", "description": "Page number starting from 1" }, "value": { "type": "string", "description": "Filter capabilities for Value. Supports the following operators: equals, starts with, ends with, not equals, and contains pattern. Filtering is case-sensitive." } }, "required": [ "PCID" ]}
Boolean indicating if the list is managed and list modifications can be made from this partner app id only
searchCriteria
string
No
—
What attribute to search by
value
string
Yes
—
Name of the list
Show inputSchema
{ "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "listId": { "type": "string", "description": "The unique identifier of the list" }, "displayFormat": { "type": "string", "description": "Whether we display code or value first", "enum": [ "(CODE) TEXT", "TEXT (CODE)" ] }, "isManaged": { "type": "boolean", "description": "Boolean indicating if the list is managed and list modifications can be made from this partner app id only" }, "searchCriteria": { "type": "string", "description": "What attribute to search by", "enum": [ "TEXT", "CODE" ] }, "value": { "type": "string", "description": "Name of the list" } }, "required": [ "PCID", "listId", "value" ]}