List All
Lists a project's contact lists with a total count. Narrow to one kind with type, or pass contactId to find the lists a particular contact belongs to.
Authorization
Authorization In: header
Path Parameters
ID of the project to list contact lists from.
Query Parameters
Only return lists that this contact is a member of.
Field to sort by.
Sort direction. Ignored unless orderBy is set.
Number of lists to skip before collecting results.
Maximum number of lists to return.
Only return lists of this kind: static for a fixed set of members you manage explicitly, dynamic for a saved filter whose membership is recomputed on read.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://www.saasco.com/api/v2/projects/string/crm/contact-lists"{
"count": 0,
"data": [
{
"id": "string",
"createdAt": "string",
"updatedAt": "string",
"name": "string",
"description": "string",
"type": "static",
"contactsFilterGroups": [
{
"filters": [
{
"attributeDistinctId": "string",
"attributeType": "string",
"operator": "equals",
"value": "string"
}
],
"oneDayEventFilters": [
{
"eventName": "string",
"operator": "performed"
}
],
"groupType": "AND",
"requireSubscribed": true
}
],
"projectId": "string"
}
]
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Delete Attributes
The bulk form of Delete Attribute, removing several attributes from every contact in one call. Same asynchronous behaviour: one background job per attribute, returned as job handles. Cannot be undone.
Get List
Fetches a single contact list with its configuration, including the filter definition for a dynamic list. Members are not included. Use List Members for those.