{
"opencollection": "1.0.0",
"info": {
"name": "Pipedrive API v1 Activities Filters API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "Filters",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all filters",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/filters",
"params": [
{
"name": "type",
"value": "",
"type": "query",
"description": "The types of filters to fetch"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about all filters."
},
{
"info": {
"name": "Add a new filter",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://api.pipedrive.com/v1/filters",
"params": [
{
"name": "include_field_code",
"value": "",
"type": "query",
"description": "If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Adds a new filter, returns the ID upon success. Note that in the conditions JSON object only one first-level condition group is supported, and it must be glued with 'AND', and only two second level condition groups are supported of which one must be glued with 'AND' and the second with 'OR'. Other combinations do not work (yet) but the syntax supports introducing them in future. For more information, see the tutorial for add or update filters. For more information, see the tutorial for adding a filter."
},
{
"info": {
"name": "Get one filter",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://api.pipedrive.com/v1/filters/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the filter"
},
{
"name": "include_field_code",
"value": "",
"type": "query",
"description": "If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Returns data about a specific filter. Note that this also returns the condition lines of the filter."
},
{
"info": {
"name": "Update filter",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://api.pipedrive.com/v1/filters/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the filter"
},
{
"name": "include_field_code",
"value": "",
"type": "query",
"description": "If set to `true`, each condition in the response includes a `field_code` field identifying the field by its code name"
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Updates an existing filter."
},
{
"info": {
"name": "Delete a filter",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://api.pipedrive.com/v1/filters/:id",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The ID of the filter"
}
],
"auth": {
"type": "apikey",
"key": "x-api-token",
"value": "{{x-api-token}}",
"placement": "header"
}
},
"docs": "Marks a filter as deleted."
}
]
}
],
"bundled": true
}