Get a list filter by id.

Required permissions: View Contacts and transactions

get

Path parameters

filterIDstring · uuidRequired

Query parameters

apiTokenstringRequired

API authentication token

Responses

200

OK

application/json

idstringOptional

namestringOptional

descriptionstringOptional

versioninteger · int32Optional

createDatestring · date-timeOptional

lastModifiedstring · date-timeOptional

matchesinteger · int32Optional

apiFilterStringstringOptional

englishFilterStringstringOptional

401

Incorrect Permissions or Invalid API Token

application/json

500

Engage Server Error. Unable to process response at this time.

application/json

get/database/filters/{filterID}

GET /database/filters/{filterID}?apiToken=text HTTP/1.1
Host: api.ubiquity.co.nz
Accept: */*

{
  "id": "text",
  "name": "text",
  "description": "text",
  "version": 1,
  "createDate": "2026-01-01T00:00:00.000Z",
  "lastModified": "2026-01-01T00:00:00.000Z",
  "matches": 1,
  "apiFilterString": "text",
  "englishFilterString": "text"
}