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.
Authorization
Authorization In: header
Path Parameters
ID of the project that owns the list.
ID of the contact list to fetch.
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/string"{
"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": []
}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.
Create List
Creates a contact list. A `static` list holds the members you add explicitly; a `dynamic` list stores a filter and recomputes its members on read, so contacts join and leave automatically as their properties change. Set `contactsFilterGroups` for a dynamic list.