# Create a new saved filter Creates a new saved filter with the provided configuration. Endpoint: POST /api/v2/filters Version: 1.0 Security: BearerAuthentication ## Request fields (application/json): - `uuid` (string, required) Unique identifier for the entity - `name` (string, required) The name identifier of the saved filter - `label` (string) Display label for the saved filter - `createdAt` (integer) Unix timestamp when the entity was created - `createdBy` (object) Identifier of the user who created the entity - `createdBy.name` (string, required) - `createdBy.label` (string) - `createdBy.createdAt` (integer) - `createdBy.updatedAt` (integer) - `createdBy.deletedAt` (integer) - `createdBy.createdByUuid` (string) - `createdBy.updatedByUuid` (string) - `createdBy.deletedByUuid` (string) - `createdBy.index` (integer) - `createdBy.complete` (boolean) - `createdBy.deleted` (boolean) - `createdBy.uuid` (string, required) - `createdBy.objects` (object) - `createdBy.properties` (array) - `createdBy.properties.value` (any) - `createdBy.properties.type` (string) - `createdBy.properties.icon` (string) - `createdBy.user` (object) - `createdBy.user.email` (string) - `createdBy.user.firstname` (string) - `createdBy.user.lastname` (string) - `createdBy.user.initials` (string) - `createdBy.user.scopes` (array) - `createdBy.user.filters` (object) - `createdBy.user.role` (string) - `createdBy.user.record` (object) - `updatedAt` (integer) Unix timestamp when the entity was last updated - `updatedBy` (object) Identifier of the user who last updated the entity - `deletedAt` (integer) Unix timestamp when the entity was deleted (null if not deleted) - `deletedBy` (object) Identifier of the user who deleted the entity - `index` (integer) Index number for ordering entities - `description` (string) Description of what this saved filter is used for - `mainObject` (string) The main object for the saved filter - `filter` (object) The filter definition used when querying records - `filter.groups` (array) A collection of filter groups. - `filter.groups.items` (object) A set of filter items included in the group. - `filter.groups.items.object` (string) The name of the object to which this pagination item belongs. Example: "User" - `filter.groups.items.relation` (string) The relationship between objects. Example: "hasProperty" - `filter.groups.items.property` (string) The name of the property within the object. Example: "email" - `filter.groups.items.relationIncluded` (boolean) Specifies whether the relation is included. Example: true - `filter.groups.items.operator` (string) Defines the operator used in the filter. Available operators are defined in the API documentation. Example: "EQUALS" - `filter.groups.items.value` (any) Represents the value to filter against. Example: 12345 ## Response 201 fields (application/json): - `message` (string) A message detailing the result of the operation. Example: "Success" - `data` (any) The data payload of the response, if any. ## Response 400 fields (application/json): - `message` (string) The error message providing details about the failure. Example: "Resource not found." - `errors` (object) A list of error types providing further details about the error. Example: [{"field":"name","message":"Name is required.","correctionSuggestion":"Please provide a name."}] - `errors.correctionSuggestion` (string, required) A suggestion on how to correct the error. Example: "Try uploading a different file type." - `errors.type` (string, required) The type of error. Enum: "VALIDATION", "NOT_FOUND", "TEST", "RELATION_NOT_ALLOWED", "INVALID_VALUE", "GENERAL", "INVALID_FILE_TYPE", "INTERNAL_SERVER_ERROR", "CARAER_ERROR", "INVALID_EMAIL", "INVALID_DATE" - `status` (integer) The HTTP status code associated with the error. Example: 400 - `stackTrace` (string) - `roles` (array) Enum: "USER", "ADMIN", "RESELLER", "DEVELOPER", "SUPER_ADMIN" - `scopes` (array) ## Response 500 fields (application/json): - `message` (string) The error message providing details about the failure. Example: "Resource not found." - `errors` (object) A list of error types providing further details about the error. Example: [{"field":"name","message":"Name is required.","correctionSuggestion":"Please provide a name."}] - `errors.correctionSuggestion` (string, required) A suggestion on how to correct the error. Example: "Try uploading a different file type." - `errors.type` (string, required) The type of error. Enum: "VALIDATION", "NOT_FOUND", "TEST", "RELATION_NOT_ALLOWED", "INVALID_VALUE", "GENERAL", "INVALID_FILE_TYPE", "INTERNAL_SERVER_ERROR", "CARAER_ERROR", "INVALID_EMAIL", "INVALID_DATE" - `status` (integer) The HTTP status code associated with the error. Example: 400 - `stackTrace` (string) - `roles` (array) Enum: "USER", "ADMIN", "RESELLER", "DEVELOPER", "SUPER_ADMIN" - `scopes` (array)