Skip to main content
All list endpoints accept filters as query parameters. Filters are optional and combine with AND logic: every filter sent must be satisfied for a record to appear in the result. Invalid filters return 422 with the exact field that failed validation.

​
Filters by resource

​
GET /v1/people

ParameterTypeComparisonDescription
full_namestringcontains (ilike)Filter by name. Case-insensitive.
emailstringexactFilter by email address. Exact match across all emails on the contact.
company_idUUIDexactReturns only people linked to the given company.
created_afterISO 8601>=Records created on or after this date.
created_beforeISO 8601<=Records created on or before this date.
updated_afterISO 8601>=Records updated on or after this date.
updated_beforeISO 8601<=Records updated on or before this date.
# People from company X created in 2026
curl "https://api.vendaze.com/v1/people?company_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890&created_after=2026-01-01T00:00:00Z" \
  -H "Authorization: Bearer {access_token}"

​
GET /v1/companies

ParameterTypeComparisonDescription
full_namestringcontains (ilike)Filter by company name. Case-insensitive.
emailstringexactFilter by email address. Exact match across all emails on the company.
created_afterISO 8601>=Records created on or after this date.
created_beforeISO 8601<=Records created on or before this date.
updated_afterISO 8601>=Records updated on or after this date.
updated_beforeISO 8601<=Records updated on or before this date.
# Companies with "tech" in their name
curl "https://api.vendaze.com/v1/companies?full_name=tech" \
  -H "Authorization: Bearer {access_token}"

​
GET /v1/tasks

ParameterTypeComparisonDescription
person_idUUIDexactTasks linked to the given person.
company_idUUIDexactTasks linked to the given company.
deal_idUUIDexactTasks linked to the given deal.
type_idUUIDexactTasks of the given type.
prioritystringexacthigh, medium, or low.
completedbooleanexacttrue for completed tasks, false for open ones.
created_afterISO 8601>=Tasks created on or after this date.
created_beforeISO 8601<=Tasks created on or before this date.
# High-priority open tasks for a person
curl "https://api.vendaze.com/v1/tasks?person_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890&priority=high&completed=false" \
  -H "Authorization: Bearer {access_token}"

​
GET /v1/products

ParameterTypeComparisonDescription
namestringcontains (ilike)Filter by product name. Case-insensitive.
is_activebooleanexacttrue for active products, false for inactive ones.
currencystringexactISO 4217 currency code (e.g., BRL, USD). Filters by product currency.
billing_cyclestringexactmonthly, yearly, weekly, daily, or one_time.
# Active monthly products in USD
curl "https://api.vendaze.com/v1/products?is_active=true&currency=USD&billing_cycle=monthly" \
  -H "Authorization: Bearer {access_token}"

​
GET /v1/tags

ParameterTypeComparisonDescription
namestringcontains (ilike)Filter by tag name. Case-insensitive.
curl "https://api.vendaze.com/v1/tags?name=vip" \
  -H "Authorization: Bearer {access_token}"

​
GET /v1/lists

ParameterTypeComparisonDescription
namestringcontains (ilike)Filter by list name. Case-insensitive.
curl "https://api.vendaze.com/v1/lists?name=leads" \
  -H "Authorization: Bearer {access_token}"

​
GET /v1/task-types

ParameterTypeComparisonDescription
titlestringcontains (ilike)Filter by task type title. Case-insensitive.
curl "https://api.vendaze.com/v1/task-types?title=call" \
  -H "Authorization: Bearer {access_token}"

​
GET /v1/custom-fields

ParameterTypeComparisonDescription
show_peoplebooleanexacttrue for fields that appear on people.
show_companiesbooleanexacttrue for fields that appear on companies.
show_dealsbooleanexacttrue for fields that appear on deals.
# Custom fields visible on both people and companies
curl "https://api.vendaze.com/v1/custom-fields?show_people=true&show_companies=true" \
  -H "Authorization: Bearer {access_token}"

​
Combining filters with pagination

Filters combine normally with pagination parameters (page, per_page, order_by, order). The meta.total in the response always reflects the total number of records matching the applied filters, not the overall workspace total. 
# People from company X, sorted by name, page 2
curl "https://api.vendaze.com/v1/people?company_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890&order_by=full_name&order=asc&page=2&per_page=25" \
  -H "Authorization: Bearer {access_token}"

​
Validation errors

Filters with invalid values return 422 identifying the field: 
{
  "error": {
    "code": "validation_error",
    "message": "Validation failed.",
    "fields": {
      "company_id": "Must be a valid UUID.",
      "created_after": "Must be a valid ISO 8601 date."
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000"
  }
}