Get Plusapp User Filters

Get User Filter Details

Base URL

https://apimobile.callproof.com

Endpoint

/api/user-filter/{filter_type_id}

Purpose

Retrieves the saved filter settings for the authenticated user and company for a given filter type. When retrieving contact filters and custom-field filters also exist, related custom field definitions/values may be included.

HTTP Method

GET

Headers

Header	Required	Description
Authorization	Yes	Bearer access token

Security

• Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter	Type	Required	Description
filter_type_id	integer	Yes	Filter type identifier to retrieve (for example, contacts = 1, custom fields = 8)

Query Parameters

Parameter	Type	Required	Description
filter_type_id	integer	No	Also checked when deciding whether to include custom fields with contact filters (contacts = 1)

Request Body

None.

Successful Response (200)

Returns the stored filter payload for the requested type.

Field	Type	Description
clientStatusCode	integer	Status indicator for the client (for example, 200)
user_id	integer	Identifier of the authenticated user
company_id	integer	Identifier of the authenticated user’s company
data	object	Filter details payload
uri	string	Requested resource URI

data

Field	Type	Description
filter	array/object	Decoded filter criteria. Empty array when no filter is saved for this type
double_quotes	boolean	Indicates whether search text needed special quote handling
custom_fields	array	Custom field definitions/values included when contact filters are requested and custom-field filters exist; otherwise an empty array

Error Responses

Status Code	Meaning
400	Bad Request – user filter details could not be retrieved
401	Unauthorized – missing, invalid, or expired Bearer token

• 400 – An error occurred while fetching filter details (for example, "Error while fetching user filter details").
• 401 – Authentication failed or the access token is missing/expired.