Fetch Multiple Lists
GET {{baseUrl}}/crm/v3/lists/?listIds=<integer>&listIds=<integer>&includeFilters=false
Fetch multiple lists in a single request by ILS list ID. The response will include the definitions of all lists that exist for the listIds
provided.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
listIds | string | The ILS IDs of the lists to fetch. | |
listIds | string | The ILS IDs of the lists to fetch. | |
includeFilters | boolean | A flag indicating whether or not the response object list definitions should include a filter branch definition. By default, object list definitions will not have their filter branch definitions included in the response. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"lists":[{"listId":"\u003cinteger\u003e","listVersion":"\u003cinteger\u003e","name":"\u003cstring\u003e","objectTypeId":"\u003cstring\u003e","processingStatus":"\u003cstring\u003e","processingType":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","filtersUpdatedAt":"\u003cdateTime\u003e","deletedAt":"\u003cdateTime\u003e","createdById":"\u003cinteger\u003e","updatedById":"\u003cinteger\u003e","filterBranch":{"filterBranchOperator":"\u003cstring\u003e","filterBranchType":"OR","filterBranches":[{"value":"\u003cCircular reference to #/components/schemas/PublicOrFilterBranch detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/PublicOrFilterBranch detected\u003e"}],"filters":[{"filterType":"PROPERTY","operation":{"includeObjectsWithNoValueSet":"\u003cboolean\u003e","operationType":"BOOL","operator":"\u003cstring\u003e","value":"\u003cboolean\u003e"},"property":"\u003cstring\u003e"},{"filterType":"PROPERTY","operation":{"includeObjectsWithNoValueSet":"\u003cboolean\u003e","operationType":"BOOL","operator":"\u003cstring\u003e","value":"\u003cboolean\u003e"},"property":"\u003cstring\u003e"}]}},{"listId":"\u003cinteger\u003e","listVersion":"\u003cinteger\u003e","name":"\u003cstring\u003e","objectTypeId":"\u003cstring\u003e","processingStatus":"\u003cstring\u003e","processingType":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","filtersUpdatedAt":"\u003cdateTime\u003e","deletedAt":"\u003cdateTime\u003e","createdById":"\u003cinteger\u003e","updatedById":"\u003cinteger\u003e","filterBranch":{"filterBranchOperator":"\u003cstring\u003e","filterBranchType":"OR","filterBranches":[{"value":"\u003cCircular reference to #/components/schemas/PublicOrFilterBranch detected\u003e"},{"value":"\u003cCircular reference to #/components/schemas/PublicOrFilterBranch detected\u003e"}],"filters":[{"filterType":"PROPERTY","operation":{"includeObjectsWithNoValueSet":"\u003cboolean\u003e","operationType":"BOOL","operator":"\u003cstring\u003e","value":"\u003cboolean\u003e"},"property":"\u003cstring\u003e"},{"filterType":"PROPERTY","operation":{"includeObjectsWithNoValueSet":"\u003cboolean\u003e","operationType":"BOOL","operator":"\u003cstring\u003e","value":"\u003cboolean\u003e"},"property":"\u003cstring\u003e"}]}}]}