{"openapi":"3.0.1","info":{"title":"Leadboxer API","description":"# LeadBoxer API Documentation\n\nHere you can find the technical documentation needed for using the LeadBoxer API, including the option to generate requests and review the outcomes.\n\n## Getting Started\n\nTo get started, please have a look at these pages that include introductions, use-cases, and additional information for the LeadBoxer API: [LeadBoxer API Documentation](https://docs.leadboxer.com/category/112-all)\n\nThese documents are intended for LeadBoxer CUSTOMERS that have a valid API license & Key. Please contact us before using the LeadBoxer API.\n\n## Warning\n\nPlease be aware that any actions you perform through this reference testing functionality will involve operations with your production data. To test your applications against some sandbox data, we recommend creating a new, separate LeadBoxer account for sandboxing purposes.\n\nThis API is under active maintenance, and we are constantly adding new functionality to this version.\n\n[**All requests to the API must be made over SSL (https, not http).**]","termsOfService":"https://www.leadboxer.com/resources/terms","contact":{"name":"Wart Fransen","url":"wart@leadboxer.com","email":"hello@leadboxer.com"},"license":{"name":"","url":"https://www.leadboxer.com/resources/privacy"},"version":"0.0.1"},"servers":[{"url":"https://api.leadboxer.com","description":"Production Server"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"User Management","description":"API endpoints for managing users within an account. These operations allow you to create users, update their basic information, manage invitations, retrieve their accessible datasets, and remove users when needed."},{"name":"LeadOperation","description":"Manage your Lead."},{"name":"Lookup API","description":"APIs for IP, Domain and Email lookup operations"},{"name":"Dataset Management","description":"Manage your datasets. Add, update, delete datasets from your account, configure preferences, and manage form tracking."},{"name":"Segments","description":"Manage your segments. Add, update, delete segments for your datasets etc."},{"name":"Segment Preference","description":"Defines and manages which segment is set as default for a given combination of User ID and Dataset ID.\nA user can have multiple segments under a dataset, but only one of them can be designated as the default at any time.\nThese APIs handle creation, retrieval, and updates of that default segment."},{"name":"Leads","description":"Get your top leads with fine grained filtering criteria."},{"name":"UserDatasets","description":"Manage access to your datasets. Associate/dissociate datasets with users etc."}],"paths":{"/v1/users/{userId}/name":{"put":{"tags":["User Management"],"summary":"Update User Name","description":"Updates the display name of an existing user.","operationId":"updateName","parameters":[{"name":"userId","in":"path","description":"Unique ID of the user to be updated.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserName"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"User Name updated successfully. No content returned."}}}},"/v1/segments/{segmentId}":{"put":{"tags":["Segments"],"summary":"Update Existing Segment","description":"Update an existing segment with the given configuration. Use this endpoint to update filter criteria, email preferences etc.","operationId":"updateSegment","parameters":[{"name":"segmentId","in":"path","description":"Segment ID","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"segmentName","in":"query","description":"Segment Name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSegmentRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Segment updated successfully. No content returned."}}},"delete":{"tags":["Segments"],"summary":"Delete Segment","description":"To delete specified segment.","operationId":"deleteSegment","parameters":[{"name":"segmentId","in":"path","description":"Segment ID","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Segment deleted successfully. No content returned."}}}},"/v1/segments/user":{"put":{"tags":["Segments"],"summary":"Update Segment User","description":"Updates the user associated with the segment, which allow that user to access the segment.","operationId":"updateSegmentUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSegmentUserRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Segment User updated successfully. No content returned."}}}},"/v1/segment/preference":{"get":{"tags":["Segment Preference"],"summary":"Get Default Segment Users","description":"Get the list of User IDs for whom the specified segment is set as the default under the given Dataset ID.","operationId":"getUsersBySegmentIdAndDatasetId","parameters":[{"name":"email","in":"query","description":"Email associated with the account.","required":true,"schema":{"type":"string"}},{"name":"segmentId","in":"query","description":"Segment ID for which you want to retrieve the list of users who have this segment set as default.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"datasetId","in":"query","description":"Dataset ID under which the segment’s default users should be retrieved.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetAllResponseLong"}}}}}},"put":{"tags":["Segment Preference"],"summary":"Add/Update Default Segment for Users","description":"Sets the given Segment ID as the default segment for the provided list of User IDs under the specified Dataset ID.\nUsers included in the list will have their default segment added or updated accordingly.\nAny users not included in the list will have their existing default-segment association under this dataset removed.","operationId":"saveDefaultSegment","parameters":[{"name":"email","in":"query","description":"Email associated with the account.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentPreferenceRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Segment Preference updated successfully. No content returned."}}},"delete":{"tags":["Segment Preference"],"summary":"Remove Default Segment","description":"Remove Default Segment for the user with the given Email under the given Dataset ID.","operationId":"deleteDefaultSegment","parameters":[{"name":"email","in":"query","description":"Email associated with the account. Default Segment for this user under the given dataset will be removed.","required":true,"schema":{"type":"string"}},{"name":"datasetId","in":"query","description":"Dataset ID from which default segment is to be removed.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Default Segment removed successfully. No content returned."}}}},"/v1/management/lead-tags":{"put":{"tags":["LeadOperation"],"summary":"Update Lead Tags","description":"Adds or removes lead tags for a specified lead.","operationId":"updateLeadTags","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadTagsUpdateRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Tags updated successfully. No content returned."}}}},"/v1/management/ctd/update":{"put":{"tags":["Custom Tracking Domains"],"summary":"Update Custom Tracking Domain by Dataset ID","description":"Update custom tracking domain entry for the given dataset Id and ctd.","operationId":"updatedCustomTrackingDomain","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomTrackingDomainRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Custom Tracking Domain updated successfully, no content returned."}}}},"/v1/management/assign-leads":{"put":{"tags":["LeadOperation"],"summary":"Assign Leads","description":"Assigns lead to a user.","operationId":"assignLeads","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadAssignRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Assignee created/updated successfully. No content returned."}}}},"/v1/datasets/{datasetId}/name":{"put":{"tags":["Dataset Management"],"summary":"Update Dataset Name","description":"Updates the human-readable name of the specified dataset.","operationId":"updateDatasetName","parameters":[{"name":"humanName","in":"query","required":true,"schema":{"type":"string"}},{"name":"datasetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Email associated with the account.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Dataset name updated successfully. No content returned."}}}},"/v1/datasets/{datasetId}/form-tracking":{"put":{"tags":["Dataset Management"],"summary":"Update Form Tracking","description":"Updates the form tracking configuration for the specified dataset, including enabling/disabling tracking, IP masking, and form input attributes.","operationId":"updateFormTracking","parameters":[{"name":"formTracking","in":"query","required":true,"schema":{"type":"boolean"}},{"name":"partialFormTracking","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"contactEnrichment","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"allowIpMasking","in":"query","required":true,"schema":{"type":"boolean"}},{"name":"formInputAttribute","in":"query","required":true,"schema":{"type":"string"}},{"name":"datasetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Email associated with the account.","required":true,"schema":{"type":"string"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Form Tracking updated successfully. No content returned."}}}},"/v1/users":{"post":{"tags":["User Management"],"summary":"Create or Associate User","description":"Creates a new user or associates an existing user with an account, depending on the provided data.","operationId":"addUser","parameters":[{"name":"email","in":"query","description":"Email associated with the account.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Payload containing datasets and other user information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddUser"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"User created successfully. No content returned."}}}},"/v1/user-datasets":{"get":{"tags":["UserDatasets"],"summary":"Fetch User Datasets","description":"Retrieves the datasets associated with a user for the given account. This provides details about the user's datasets under their account.","operationId":"getUserDatasets_1","parameters":[{"name":"accountId","in":"query","description":"The unique identifier for the user's account.","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"The email address of the user for whom datasets are being fetched.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetAllResponseAccountUserDatasetDTO"}}}}}},"post":{"tags":["UserDatasets"],"summary":"Add User Dataset","description":"Associates a user with a dataset. This operation allows the user to access and work with the specified dataset.","operationId":"addUserDataset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddUserDataset"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"User successfully associated with given dataset. No content returned."}}},"delete":{"tags":["UserDatasets"],"summary":"Remove User Dataset","description":"Disassociates a user from a dataset. This operation will prevent the user from accessing the specified dataset.","operationId":"removeUserDataset","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveUserDataset"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"No Content"}}}},"/v1/segments":{"get":{"tags":["Segments"],"summary":"Retrieve Segments for a Given Site","description":"Fetches segments associated with a specified dataset and account, for a user identified by email.","operationId":"getSegments","parameters":[{"name":"email","in":"query","description":"The email address of the user making the request.","required":true,"schema":{"type":"string"}},{"name":"accountId","in":"query","description":"The Leadboxer account ID associated with the segments.","required":true,"schema":{"type":"string"}},{"name":"datasetId","in":"query","description":"The dataset for which to fetch segments.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetAllResponseSmartlistDTO"}}}}}},"post":{"tags":["Segments"],"summary":"Create a New Segment","description":"Creates a new segmentRequest for the specified account and dataset using the provided configuration. This includes applying filters and setting up any email notification preferences.","operationId":"createSegment","parameters":[{"name":"email","in":"query","description":"The email address of the user creating the segmentRequest.","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The configuration details for the new segmentRequest, including filters and email notification settings.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSegmentRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateResponseDTOInteger"}}}}}}},"/v1/management/ctd/validate":{"post":{"tags":["Custom Tracking Domains"],"summary":"Validate Custom Tracking Domain","description":"Validate the given custom tracking domain.","operationId":"validateCustomTrackingDomain","requestBody":{"description":"Custom Tracking Domain Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomTrackingDomainRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomTrackingDomainValidationResponse"}}}}}}},"/v1/management/ctd/add":{"post":{"tags":["Custom Tracking Domains"],"summary":"Add Custom Tracking Domain","description":"Adds a custom tracking domain to the dataset and triggers the certificate generation process. <br/><br/><b>Note:</b> This operation may take several minutes to complete.<br/><br/>The response indicates whether the request resulted in an error, completed successfully, or requires additional DNS configuration.","operationId":"addCustomTrackingDomain","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomTrackingDomainRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"Indicates the result of adding a custom tracking domain.<br/>Response code 0 indicates success, while response code -1 indicates failure; details are provided in the responseMessage.","content":{"application/json":{"examples":{"Success":{"description":"Success","value":{"responseCode":0,"responseMessage":"Successfully added the track.example.com as the custom tracking domain."}},"Error":{"description":"Error","value":{"responseCode":-1,"responseMessage":"Something went wrong while adding ctd."}}}}}}}}},"/v1/email-lookup":{"get":{"tags":["Lookup API"],"summary":"Email Lookup (GET)","description":"Same as POST /v1/email-lookup, with the email and the optional hints as query parameters, for consistency with the IP and domain lookups. Prefer POST where possible: with GET the email address ends up in URLs, browser history and server logs. Available on every plan. Credits are only consumed when a profile is found.","operationId":"lookupEmailByQuery","parameters":[{"name":"email","in":"query","description":"Email address of the contact to enrich","required":true,"schema":{"type":"string"},"example":"jane.doe@leadboxer.com"},{"name":"firstName","in":"query","description":"First name of the contact (optional hint)","required":false,"schema":{"type":"string"}},{"name":"lastName","in":"query","description":"Last name of the contact (optional hint)","required":false,"schema":{"type":"string"}},{"name":"companyName","in":"query","description":"Name of the company the contact works for (optional hint)","required":false,"schema":{"type":"string"}},{"name":"companyDomain","in":"query","description":"Domain of the company the contact works for (optional hint)","required":false,"schema":{"type":"string"}},{"name":"datasetId","in":"query","description":"The dataset ID to associate with the operation’s credit. If not specified, a dataset linked to the account will be selected.","required":false,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"Successfully retrieved contact profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactProfileDetails"}}}}}},"post":{"tags":["Lookup API"],"summary":"Email Lookup","description":"Retrieve the professional profile of a contact by email address. Only the email is required; name and company are optional hints that improve matching. Available on every plan. Credits are only consumed when a profile is found.\n\nThe same lookup is also available as GET /v1/email-lookup?email=..., but POST is recommended because it keeps the email address out of URLs and server logs.\n\nReturned Data\nWhen a match is found, the following fields are returned:\n\nContact details\n- email\n- fullName\n- headline\n- linkedinUrl\n- seniority\n- jobFunction\n- location\n\nLanguages\n- languages[].name\n- languages[].proficiency\n\nExperience\n- experience[].title\n- experience[].companyName\n- experience[].startYear\n- experience[].endYear\n- experience[].current","operationId":"lookupEmail","parameters":[{"name":"datasetId","in":"query","description":"The dataset ID to associate with the operation’s credit. If not specified, a dataset linked to the account will be selected.","required":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactEnrichmentRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"Successfully retrieved contact profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactProfileDetails"},"examples":{"Success":{"description":"Success","value":{"email":"jane.doe@leadboxer.com","fullName":"Jane Doe","headline":"Head of Marketing at LeadBoxer","linkedinUrl":"https://www.linkedin.com/in/janedoe","seniority":"Senior","jobFunction":"Marketing","location":"Amsterdam, North Holland, Netherlands","languages":[{"name":"English","proficiency":"Native or bilingual proficiency"}],"experience":[{"title":"Head of Marketing","companyName":"LeadBoxer","startYear":2021,"current":true}]}}}}}}}}},"/v1/datasets":{"post":{"tags":["Dataset Management"],"summary":"Add Dataset","description":"Creates a new dataset in the account and associates it with the specified users.","operationId":"addDataset","parameters":[{"name":"email","in":"query","description":"User email.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddDataset"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreateResponseDTOString"}}}}}}},"/v1/dataset-exclusion":{"get":{"tags":["Leads"],"summary":"Retrieve leads exclusions","description":"Use this API to retrieve dataset exclusion rules. ","operationId":"getDatasetExclusions","parameters":[{"name":"datasetId","in":"query","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetAllResponseDatasetTypeExclusionResponse"}}}}}},"post":{"tags":["Leads"],"summary":"Hide leads","description":"Use this API to define exclusion rules for specific datasets. These rules allow you to hide leads based on different criteria, such as a specific identifier (use_id) or attributes like organizationName or organizationDomain. Each rule is created using a combination of type and data for a given dataset.","operationId":"saveDatasetExclusion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveDatasetExclusion"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"DatasetExclusion saved successfully."}}},"delete":{"tags":["Leads"],"summary":"Unhide leads","description":"Use this API to delete existing dataset exclusion rules.","operationId":"deleteDatasetExclusion","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveDatasetExclusion"}}},"required":true},"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"DatasetExclusion deleted successfully."}}}},"/api/credits/usage/timeseries":{"post":{"tags":["credit-reporting-controller"],"operationId":"getUsageOverTime","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditUsageTimeSeriesRequest"}}},"required":true},"responses":{"429":{"description":"Too Many Requests – rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"400":{"description":"Parameterized error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParameterizedErrorVM"}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorVM"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorVM"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetAllResponseDailyUsage"}}}}}}},"/api/credits/usage/summary":{"post":{"tags":["credit-reporting-controller"],"operationId":"getCreditUsageSummary","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditUsageSummaryRequest"}}},"required":true},"responses":{"429":{"description":"Too Many Requests – rate limit exceeded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"400":{"description":"Parameterized error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParameterizedErrorVM"}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorVM"}}}},"403":{"description":"Forbidden","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorVM"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CreditUsageSummary"}}}}}}},"/v1/users/{userId}/invite/resend":{"get":{"tags":["User Management"],"summary":"Resend User Invitation","description":"Resends an invitation email to the specified user.","operationId":"resendInvite","parameters":[{"name":"userId","in":"path","description":"ID of the user whose invitation is being resent.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"email","in":"query","description":"Email associated with the account.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Invitation sent successfully. No content returned."}}}},"/v1/users/datasets":{"get":{"tags":["User Management"],"summary":"Get User Datasets","description":"Returns the list of datasets the authenticated user has access to.","operationId":"getUserDatasets","parameters":[{"name":"email","in":"query","description":"Email associated with the account.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetAllResponseUserDatasetDTO"}}}}}}},"/v1/management/ctd/{datasetId}":{"get":{"tags":["Custom Tracking Domains"],"summary":"Get Custom Tracking Domain by Dataset ID","description":"Get all custom tracking domains for a given dataset Id.","operationId":"getCustomTrackingDomains","parameters":[{"name":"datasetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllResponseCustomTrackingDomainDTO"}}}}}},"delete":{"tags":["Custom Tracking Domains"],"summary":"Delete Custom Tracking Domain by Dataset ID","description":"Delete custom tracking domain entry for the given dataset Id and ctd.","operationId":"deleteCustomTrackingDomain","parameters":[{"name":"ctd","in":"query","required":true,"schema":{"type":"string"}},{"name":"datasetId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Custom Tracking Domain deleted successfully, no content returned."}}}},"/v1/management/credits":{"get":{"tags":["Credit Management"],"summary":"Get Credit Grants","operationId":"getAvailableCreditGrants","responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetAllResponseCreditGrantDTO"}}}}}}},"/v1/leads":{"get":{"tags":["Leads"],"summary":"Retrieve Leads","description":"Returns a list of leads in JSON format based on the provided filters and query parameters.","operationId":"users","parameters":[{"name":"site","in":"query","description":"The Dataset ID","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Keyword or phrase to search across all searchable fields. Search is case-insensitive for text fields. Defaults to '*' to match all results.","required":false,"schema":{"type":"string","default":"*"}},{"name":"limit","in":"query","description":"No of rows to return in response.","required":false,"schema":{"type":"integer","format":"int32","default":50}},{"name":"locale","in":"query","description":"Locale for formatting the 'prettyLastEvent' field in response. Determines the language and regional formatting (e.g., dates, text) returned by the API.","required":false,"schema":{"type":"string","default":"en_US"},"example":"en_US"},{"name":"nextToken","in":"query","description":"Token returned after each request, used to fetch the next page of results. Each token is valid for 10 minutes.","required":false,"schema":{"type":"string"}},{"name":"criteriaTextFilter","in":"query","description":"Text-based filter expression used to filter result fields.Format: field|operator|value. Multiple filters are comma-separated.","required":false,"schema":{"type":"string"},"examples":{"Does not contain – organization name":{"description":"Does not contain – organization name","value":"organizationName.raw|doesnotcontain|Cirrus"},"Employee range with tag exclusion":{"description":"Employee range with tag exclusion","value":"organizationEmployeeCountRangeName.raw|is|51-200;201-500,lead_tags.raw|isnot|customer;competitor"},"Industry contains":{"description":"Industry contains","value":"organizationIndustryName.raw|contains|Computer Software"},"Is – single country":{"description":"Is – single country","value":"organizationCountry.raw|is|Denmark"},"URL exact match":{"description":"URL exact match","value":"original_url.raw|is|http://www.justpayy.com"},"Multiple filters combined":{"description":"Multiple filters combined","value":"organizationName.raw|contains|scuba equipment,last_country_name.raw|inregion|APAC,organizationIndustryName.raw|is|water sports"},"Complex real example":{"description":"Complex real example","value":"organizationName.raw|is|google trends boutech,last_country_name.raw|is|Philippines"},"In region":{"description":"In region","value":"last_country_name.raw|inregion|APAC"},"Is – multiple countries":{"description":"Is – multiple countries","value":"organizationCountry.raw|is|Sweden;Norway;Denmark"},"Contains – URL path":{"description":"Contains – URL path","value":"original_url.raw|contains|/solutions/clinicalkey"},"Contains – organization name":{"description":"Contains – organization name","value":"organizationName.raw|contains|bank"},"In category":{"description":"In category","value":"organizationIndustryName.raw|incategory|Construction"}}},{"name":"criteriaNumberFilter","in":"query","description":"Numeric filter expression used to filter results based on numeric fields. Format: field|operator|value. Multiple filters are comma-separated. Supported numeric operators include greaterthan, lessthan, is, isnot, between, and notbetween. The between and notbetween operators use the format min-max.","required":false,"schema":{"type":"string"},"examples":{"Between range":{"description":"Between range","value":"user.total_pages_viewed|between|10-50"},"Less than":{"description":"Less than","value":"user.total_number_visits|lessthan|50"},"Combined exclusion and range":{"description":"Combined exclusion and range","value":"user.total_number_visits|isnot|21,user.total_pages_viewed|between|10-100"},"Greater than":{"description":"Greater than","value":"user.total_number_visits|greaterthan|12"},"Not between range":{"description":"Not between range","value":"user.total_pages_viewed|notbetween|5-20"},"Multiple numeric filters":{"description":"Multiple numeric filters","value":"user.total_number_visits|greaterthan|12,user.total_pages_viewed|greaterthan|10"},"Not equal":{"description":"Not equal","value":"user.total_number_visits|isnot|21"},"Exact match":{"description":"Exact match","value":"user.total_number_visits|is|12"}}},{"name":"criteriaTimeFilter","in":"query","description":"Time-based filter expression used to filter results by time field. Format: field|operator|value.\n\nAllowed fields (same as `timeField` parameter):\n- eventEsTimestamp : Last Seen\n- first_session_unix_timestamp : First Seen\n\nSupported operators:\n- exactly   → integer value (0 = Today, 1 = Yesterday)\n- lessthan  → integer value (e.g. 6 = last 7 days)\n- between   → date range in format dd/MM/yyyy-dd/MM/yyyy\n\nLocale settings are taken into account while interpreting dates and returning results.","required":true,"schema":{"type":"string"},"examples":{"Today":{"description":"Today","value":"eventEsTimestamp|exactly|0"},"Last 30 days":{"description":"Last 30 days","value":"eventEsTimestamp|lessthan|29"},"Yesterday":{"description":"Yesterday","value":"eventEsTimestamp|exactly|1"},"Last 7 days":{"description":"Last 7 days","value":"eventEsTimestamp|lessthan|6"},"Custom date range":{"description":"Custom date range","value":"eventEsTimestamp|between|04/11/2025-10/12/2025"}}},{"name":"criteriaFieldFilter","in":"query","description":"Field-based filter used to include leads based on field presence.\n\nFormat:\noperator|field1;field2\n\nAllowed operator:\n- hasanyvalue\n\nAllowed fields:\n- firstName\n- lastName\n- email\n\nMultiple fields can be provided using semicolons.","required":false,"schema":{"type":"string"},"examples":{"Has any value (email)":{"description":"Has any value (email)","value":"hasanyvalue|email"},"Has any value (first or last name)":{"description":"Has any value (first or last name)","value":"hasanyvalue|firstName;lastName"}}},{"name":"criteriaExitLinkFilter","in":"query","description":"Exit link filter used to include or exclude leads based on exit link values.\n\nFormat:\nfield|operator|value\n\nSupported operators:\n- contains\n- is\n- isnot\n- doesnotcontain\n\nMultiple values can be provided using semicolons.","required":false,"schema":{"type":"string"},"examples":{"Contains exit link":{"description":"Contains exit link","value":"exitLinkFilter|contains|leads"}}},{"name":"criteriaLeadscoreFilter","in":"query","description":"Minimum lead score threshold (optional). Only records with lead scores greater than the provided number (0–100) are returned.","required":false,"schema":{"maximum":100,"minimum":0,"type":"integer","format":"int32"}},{"name":"criteriaDisplayFilter","in":"query","description":"Display filter used to control which types of leads are returned.\n\nSupported values:\n- company\n- person\n- unidentified\n\nSelecting 'unidentified' returns leads that could not be identified as a company or a person.\n\nMultiple values can be provided using semicolons.","required":false,"schema":{"type":"string"},"examples":{"Person leads only":{"description":"Person leads only","value":"person"},"Company and unidentified leads":{"description":"Company and unidentified leads","value":"company;unidentified"},"All lead types":{"description":"All lead types","value":"company;person;unidentified"},"Company leads only":{"description":"Company leads only","value":"company"},"Unidentified leads":{"description":"Unidentified leads","value":"unidentified"}}},{"name":"timeField","in":"query","description":"Time field used for filtering.\n\nAllowed values:\n- eventEsTimestamp : Last Seen\n- first_session_unix_timestamp : First Seen","required":true,"schema":{"type":"string","default":"eventEsTimestamp","enum":["eventEsTimestamp","first_session_unix_timestamp"]}},{"name":"usePresetExclusionList","in":"query","description":"Use a preset exclusion list of criteria to exclude from result.","required":false,"schema":{"type":"string","enum":["use_id","last_most_likely_company","organizationName","organizationDomain"]},"examples":{"Exclude by use_id":{"description":"Exclude by use_id","value":"use_id"},"Exclude by multiple types":{"description":"Exclude by multiple types","value":"use_id,last_most_likely_company,organizationName,organizationDomain"}}},{"name":"userId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"timeZone","in":"query","description":"Time zone used when parsing timestamps and evaluating time-based filters. \nIf not provided, the default time zone is Europe/Amsterdam.","required":false,"schema":{"type":"string","default":"Europe/Amsterdam"},"example":"Europe/Amsterdam"},{"name":"sortBy","in":"query","description":"Sort results by a specific field and direction.\n\nFormat:\nfield|direction\n\nAllowed fields:\n- lastEvent\n- _score\n\nAllowed directions:\n- asc\n- desc","required":false,"schema":{"type":"string"},"examples":{"Sort by time field (desc)":{"description":"Sort by time field (desc)","value":"lastEvent|desc"},"Sort by score field (desc)":{"description":"Sort by score field (desc)","value":"_score|desc"},"Sort by time field (asc)":{"description":"Sort by time field (asc)","value":"lastEvent|asc"},"Sort by score field (asc)":{"description":"Sort by score field (asc)","value":"_score|asc"}}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllResponse"},"example":{"data":[{"organizationDomain":"example-domain.test","esScore":"88","lastEvent":"9999999999999","last_country_name":"Fakeland","last_region_name":"SampleRegion","last_city":"DemoCity"}],"metaData":{"nextToken":"placeholder_next_token_123","rows":1,"totalRows":999,"queryTime":{"timeZone":"UTC","queryTime":1111111111,"periodFromTime":1100000000,"periodToTime":1199999999}}}}}}}}},"/v1/leads/{leadId}":{"get":{"tags":["Leads"],"summary":"Retrieve Lead Details","description":"Returns detailed information for a single lead, identified by its lead ID.","operationId":"leadDetail","parameters":[{"name":"leadId","in":"path","description":"Unique identifier of the lead whose information is being requested.","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Email address associated with the user's account.","required":true,"schema":{"type":"string"}},{"name":"site","in":"query","description":"The Dataset ID from which the lead information should be retrieved.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"example":{"esScore":"99","eventUnixTimestamp":"9999999999999","organizationCountry":"Exampleland","organizationTwitterUrl":"https://twitter.com/example_org","organizationCity":"Sampleville","organizationType":"placeholder_education","organizationYearFounded":"1900","organization_tags":["placeholder_tag_one","placeholder_tag_two","placeholder_tag_three"]}}}}}}},"/v1/leads/sessions":{"get":{"tags":["Leads"],"summary":"Retrieve Lead Sessions","description":"Returns all sessions associated with a specific lead ID. Results can be filtered by segment and time range.","operationId":"getSessions","parameters":[{"name":"leadId","in":"query","description":"Display data for the given leadId. LeadId is a unique identifier of each lead.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The minimum number of records to be displayed in the output.<br/>Range : 1 - 10000","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"site","in":"query","description":"Dataset ID (site) for which sessions are retrieved","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Email associated with the account","required":false,"schema":{"type":"string"}},{"name":"userId","in":"query","description":"UserId associated with email","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"segmentId","in":"query","description":"Filter results using a segment filters","required":false,"schema":{"type":"integer","format":"int32"}},{"name":"minTime","in":"query","description":"Filter sessions by minimum session duration.","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"nextToken","in":"query","description":"Token returned after each request, used to fetch the next page of results. Each token is valid for 10 minutes.","required":false,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllResponseMapStringObject"}}}}}}},"/v1/leads/export":{"get":{"tags":["Leads"],"summary":"Retrieve Leads (CSV)","description":"Exports a filtered list of leads as a CSV file for download.","operationId":"usersCsv","parameters":[{"name":"site","in":"query","description":"The Dataset ID","required":true,"schema":{"type":"string"}},{"name":"search","in":"query","description":"Keyword or phrase to search across all searchable fields. Search is case-insensitive for text fields. Defaults to '*' to match all results.","required":false,"schema":{"type":"string","default":"*"}},{"name":"limit","in":"query","description":"No of rows to return in response.","required":false,"schema":{"type":"integer","format":"int32","default":50}},{"name":"locale","in":"query","description":"Locale for formatting the 'prettyLastEvent' field in response. Determines the language and regional formatting (e.g., dates, text) returned by the API.","required":false,"schema":{"type":"string","default":"en_US"},"example":"en_US"},{"name":"nextToken","in":"query","description":"Token returned after each request, used to fetch the next page of results. Each token is valid for 10 minutes.","required":false,"schema":{"type":"string"}},{"name":"criteriaTextFilter","in":"query","description":"Text-based filter expression used to filter result fields.Format: field|operator|value. Multiple filters are comma-separated.","required":false,"schema":{"type":"string"},"examples":{"Does not contain – organization name":{"description":"Does not contain – organization name","value":"organizationName.raw|doesnotcontain|Cirrus"},"Employee range with tag exclusion":{"description":"Employee range with tag exclusion","value":"organizationEmployeeCountRangeName.raw|is|51-200;201-500,lead_tags.raw|isnot|customer;competitor"},"Industry contains":{"description":"Industry contains","value":"organizationIndustryName.raw|contains|Computer Software"},"Is – single country":{"description":"Is – single country","value":"organizationCountry.raw|is|Denmark"},"URL exact match":{"description":"URL exact match","value":"original_url.raw|is|http://www.justpayy.com"},"Multiple filters combined":{"description":"Multiple filters combined","value":"organizationName.raw|contains|scuba equipment,last_country_name.raw|inregion|APAC,organizationIndustryName.raw|is|water sports"},"Complex real example":{"description":"Complex real example","value":"organizationName.raw|is|google trends boutech,last_country_name.raw|is|Philippines"},"In region":{"description":"In region","value":"last_country_name.raw|inregion|APAC"},"Is – multiple countries":{"description":"Is – multiple countries","value":"organizationCountry.raw|is|Sweden;Norway;Denmark"},"Contains – URL path":{"description":"Contains – URL path","value":"original_url.raw|contains|/solutions/clinicalkey"},"Contains – organization name":{"description":"Contains – organization name","value":"organizationName.raw|contains|bank"},"In category":{"description":"In category","value":"organizationIndustryName.raw|incategory|Construction"}}},{"name":"criteriaNumberFilter","in":"query","description":"Numeric filter expression used to filter results based on numeric fields. Format: field|operator|value. Multiple filters are comma-separated. Supported numeric operators include greaterthan, lessthan, is, isnot, between, and notbetween. The between and notbetween operators use the format min-max.","required":false,"schema":{"type":"string"},"examples":{"Between range":{"description":"Between range","value":"user.total_pages_viewed|between|10-50"},"Less than":{"description":"Less than","value":"user.total_number_visits|lessthan|50"},"Combined exclusion and range":{"description":"Combined exclusion and range","value":"user.total_number_visits|isnot|21,user.total_pages_viewed|between|10-100"},"Greater than":{"description":"Greater than","value":"user.total_number_visits|greaterthan|12"},"Not between range":{"description":"Not between range","value":"user.total_pages_viewed|notbetween|5-20"},"Multiple numeric filters":{"description":"Multiple numeric filters","value":"user.total_number_visits|greaterthan|12,user.total_pages_viewed|greaterthan|10"},"Not equal":{"description":"Not equal","value":"user.total_number_visits|isnot|21"},"Exact match":{"description":"Exact match","value":"user.total_number_visits|is|12"}}},{"name":"criteriaTimeFilter","in":"query","description":"Time-based filter expression used to filter results by time field. Format: field|operator|value.\n\nAllowed fields (same as `timeField` parameter):\n- eventEsTimestamp : Last Seen\n- first_session_unix_timestamp : First Seen\n\nSupported operators:\n- exactly   → integer value (0 = Today, 1 = Yesterday)\n- lessthan  → integer value (e.g. 6 = last 7 days)\n- between   → date range in format dd/MM/yyyy-dd/MM/yyyy\n\nLocale settings are taken into account while interpreting dates and returning results.","required":false,"schema":{"type":"string"},"examples":{"Today":{"description":"Today","value":"eventEsTimestamp|exactly|0"},"Last 30 days":{"description":"Last 30 days","value":"eventEsTimestamp|lessthan|29"},"Yesterday":{"description":"Yesterday","value":"eventEsTimestamp|exactly|1"},"Last 7 days":{"description":"Last 7 days","value":"eventEsTimestamp|lessthan|6"},"Custom date range":{"description":"Custom date range","value":"eventEsTimestamp|between|04/11/2025-10/12/2025"}}},{"name":"criteriaFieldFilter","in":"query","description":"Field-based filter used to include leads based on field presence.\n\nFormat:\noperator|field1;field2\n\nAllowed operator:\n- hasanyvalue\n\nAllowed fields:\n- firstName\n- lastName\n- email\n\nMultiple fields can be provided using semicolons.","required":false,"schema":{"type":"string"},"examples":{"Has any value (email)":{"description":"Has any value (email)","value":"hasanyvalue|email"},"Has any value (first or last name)":{"description":"Has any value (first or last name)","value":"hasanyvalue|firstName;lastName"}}},{"name":"criteriaExitLinkFilter","in":"query","description":"Exit link filter used to include or exclude leads based on exit link values.\n\nFormat:\nfield|operator|value\n\nSupported operators:\n- contains\n- is\n- isnot\n- doesnotcontain\n\nMultiple values can be provided using semicolons.","required":false,"schema":{"type":"string"},"examples":{"Contains exit link":{"description":"Contains exit link","value":"exitLinkFilter|contains|leads"}}},{"name":"criteriaLeadscoreFilter","in":"query","description":"Minimum lead score threshold (optional). Only records with lead scores greater than the provided number (0–100) are returned.","required":false,"schema":{"maximum":100,"minimum":0,"type":"integer","format":"int32"}},{"name":"criteriaDisplayFilter","in":"query","description":"Display filter used to control which types of leads are returned.\n\nSupported values:\n- company\n- person\n- unidentified\n\nSelecting 'unidentified' returns leads that could not be identified as a company or a person.\n\nMultiple values can be provided using semicolons.","required":false,"schema":{"type":"string"},"examples":{"Person leads only":{"description":"Person leads only","value":"person"},"Company and unidentified leads":{"description":"Company and unidentified leads","value":"company;unidentified"},"All lead types":{"description":"All lead types","value":"company;person;unidentified"},"Company leads only":{"description":"Company leads only","value":"company"},"Unidentified leads":{"description":"Unidentified leads","value":"unidentified"}}},{"name":"timeField","in":"query","description":"Time field used for filtering.\n\nAllowed values:\n- eventEsTimestamp : Last Seen\n- first_session_unix_timestamp : First Seen","required":true,"schema":{"type":"string","default":"eventEsTimestamp","enum":["eventEsTimestamp","first_session_unix_timestamp"]}},{"name":"usePresetExclusionList","in":"query","description":"Use a preset exclusion list of criteria to exclude from result.","required":false,"schema":{"type":"string","enum":["use_id","last_most_likely_company","organizationName","organizationDomain"]},"examples":{"Exclude by use_id":{"description":"Exclude by use_id","value":"use_id"},"Exclude by multiple types":{"description":"Exclude by multiple types","value":"use_id,last_most_likely_company,organizationName,organizationDomain"}}},{"name":"dateFormat","in":"query","required":false,"schema":{"type":"string","default":"yyyy-MM-dd HH:mm:ss"}},{"name":"userId","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"separator","in":"query","description":"Specifies the delimiter used to separate columns in the generated CSV file.","required":false,"schema":{"type":"string","default":","}},{"name":"timeZone","in":"query","description":"Time zone used when parsing timestamps and evaluating time-based filters. \nIf not provided, the default time zone is Europe/Amsterdam.","required":false,"schema":{"type":"string","default":"Europe/Amsterdam"},"example":"Europe/Amsterdam"},{"name":"sortBy","in":"query","description":"Sort results by a specific field and direction.\n\nFormat:\nfield|direction\n\nAllowed fields:\n- lastEvent\n- _score\n\nAllowed directions:\n- asc\n- desc","required":false,"schema":{"type":"string"},"examples":{"Sort by time field (desc)":{"description":"Sort by time field (desc)","value":"lastEvent|desc"},"Sort by score field (desc)":{"description":"Sort by score field (desc)","value":"_score|desc"},"Sort by time field (asc)":{"description":"Sort by time field (asc)","value":"lastEvent|asc"},"Sort by score field (asc)":{"description":"Sort by score field (asc)","value":"_score|asc"}}},{"name":"additionalCsvFields","in":"query","description":"Comma-separated list of column identifiers to be included in the CSV export.\nThe order of the values determines the column order in the generated CSV.\n","required":false,"schema":{"type":"string"},"example":"eventEsTimestamp,organizationDomain,last_channel"}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"CSV file generated successfully","headers":{"Content-Disposition":{"description":"Attachment filename","style":"simple","schema":{"type":"string","example":"attachment; filename=\"Target Audience.leadlist.20250417.+579720301.csv\""}},"nodata":{"description":"Indicates if CSV contains only headers without data rows. 'true' if no data, absent otherwise","style":"simple","schema":{"type":"string","example":true}}},"content":{"text/csv":{"schema":{"type":"string"}}}}}}},"/v1/leads/events":{"get":{"tags":["Leads"],"summary":"Retrieve Lead Events","description":"Returns all events associated with a specific session ID. Results can be optionally filtered by segment.","operationId":"getEvents","parameters":[{"name":"sessionId","in":"query","description":"Display data for the given sessionId. SessionId is a unique identifier of each session.","required":true,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"The minimum number of records to be displayed in the output.<br/>Range : 1 - 100","required":true,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32"}},{"name":"email","in":"query","description":"Email associated with the account","required":false,"schema":{"type":"string"}},{"name":"site","in":"query","description":"Dataset ID (site) for which events are retrieved","required":true,"schema":{"type":"string"}},{"name":"userId","in":"query","description":"UserId associated with email","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"segmentId","in":"query","required":false,"schema":{"type":"integer","format":"int32"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllResponseMapStringObject"}}}}}}},"/v1/ip-lookup":{"get":{"tags":["Lookup API"],"summary":"IP Address Lookup","description":"Retrieve detailed information about an IP address, including organization, geolocation, ISP details, and metadata.\n\nReturned Data\nWhen a match is found, the following fields are returned:\n\nOrganization fields\n- ipDomain\n- ipOrganization\n\nGeo location fields\n- ipCountryName\n- ipCountryCode\n- ipRegionName\n- ipCity\n- ipSubContinent\n- ipLatitude\n- ipLongitude\n- ipTimezone\n\nIP address details\n- ipIsp\n- ipRange\n- ipUsageType\n\nMeta data\n- searchIp\n- searchResponseTimeMs","operationId":"lookupIp","parameters":[{"name":"ip","in":"query","description":"IP address to lookup (IPv4|IPv6 format)","required":true,"schema":{"type":"string"},"example":"8.8.8.8"},{"name":"datasetId","in":"query","description":"The dataset ID to associate with the operation’s credit. If not specified, a dataset linked to the account will be selected.","required":false,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"Successfully retrieved IP information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IpLookupDetails"},"examples":{"Success":{"description":"Success","value":{"ipRange":"193.8.9.0/24","ipCountryCode":"CH","ipCountryName":"Switzerland","ipSubContinent":"Western Europe","ipRegionName":"Basel-Stadt","ipCity":"Basel","ipLatitude":"47.5586","ipLongitude":"7.57401","ipTimezone":"Europe/Zurich","ipIsp":"BNP Paribas S.A.","ipOrganization":"BNP Paribas S.A.","ipDomain":"group.bnpparibas","ipUsageType":"COM","searchIp":"193.8.9.0","searchResponseTimeMs":165}}}}}}}}},"/v1/domain-lookup":{"get":{"tags":["Lookup API"],"summary":"Domain Lookup","description":"Retrieve organization details associated with a domain name. Provide a clean domain name (e.g., leadboxer.com) without protocol or www prefix.\n\nReturned Data\nWhen a match is found, the following fields are returned:\n\nOrganization core details\n- organizationName\n- organizationDomain\n- organizationDomainAliases\n- organizationType\n- organizationStatus\n- organizationSource\n- organizationReportDate\n\nOrganization description\n- organizationDescription\n- organizationDescriptionShort\n\nOrganization industry & size\n- organizationIndustryCode\n- organizationIndustryGroup\n- organizationIndustryName\n- organizationEmployeeCountRangeCode\n- organizationEmployeeCountRangeName\n\nOrganization address\n- organizationAddress.organizationStreetName\n- organizationAddress.organizationCity\n- organizationAddress.organizationState\n- organizationAddress.organizationPostalCode\n- organizationAddress.organizationCountry\n- organizationAddress.organizationCountryCode\n- organizationAddress.organizationPhone\n\nOrganization social links\n- organizationSocialLinks.organizationLinkedinUrl\n\nOrganization specialties\n- organizationSpecialties","operationId":"lookupDomain","parameters":[{"name":"domain","in":"query","description":"Domain name to lookup (e.g., leadboxer.com)","required":true,"schema":{"type":"string"},"example":"leadboxer.com"},{"name":"datasetId","in":"query","description":"The dataset ID to associate with the operation’s credit. If not specified, a dataset linked to the account will be selected.","required":false,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"200":{"description":"Successfully retrieved organization information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainOrganizationDetails"},"examples":{"Success":{"description":"Success","value":{"organizationAddress":{"organizationPostalCode":"1756","organizationCity":"Sofia","organizationState":"Sofia","organizationPhone":"+359 2 408 5888","organizationCountryCode":"BG","organizationStreetName":"Bulevard Sv. Kliment Ohridski 148","organizationCountry":"Bulgaria"},"organizationDescription":"Parcel Hive specializes in the design and production of high-quality, efficient, and visually appealing Smart Delivery Solutions. We offer a comprehensive, end-to-end service that encompasses everything from concept development to production, software integration, logistical deployment, installation services, and round-the-clock maintenance and support. Our commitment is to ensure our products remain current, efficient, and reliable. With the ambition to become the global leader in the delivery and maintenance of Automated Parcel Terminals, we continuously invest in innovation to not only meet but exceed industry standards. We provide scalable electronic lockers tailored to fit and serve a wide range of environments and needs. Our solutions are deployed in apartment complexes, retail locations, e-commerce hubs, office buildings, university campuses, amusement parks, and other high-traffic areas. Our smart storage compartments are crafted from high-quality, durable materials designed to withstand even the most challenging public environments. They offer secure, reliable storage with cutting-edge anti-theft technology to safeguard your business. CyberHive™—our proprietary software solution—is engineered to meet our customers' diverse needs. It is designed for multi-platform usage, delivering an efficient storage management system and remote support to ensure seamless operation.","organizationDescriptionShort":"Parcel Hive designs and produces high-quality, efficient Smart Delivery Solutions, specializing in smart parcel lockers.","organizationDomain":"parcelhive.net","organizationDomainAliases":["parcelhive.net"],"organizationEmployeeCountRangeCode":"E","organizationEmployeeCountRangeName":"201-500","organizationIndustryCode":"147","organizationIndustryGroup":"Manufacturing","organizationIndustryName":"Automation Machinery Manufacturing","organizationName":"Parcel Hive","organizationReportDate":"2025-10-14","organizationSocialLinks":{"organizationLinkedinUrl":"linkedin.com/company/parcel-hive"},"organizationSource":"GGL_PLC","organizationSpecialties":["Logistics Companies","click and collect","parcel locker","smart lockers","Refrigerated Lockers","parcel lockers","parcel terminals","B2B Terminals","City Terminals","Commercial Buildings Terminals","E-Commerce Terminals","Food Warmer Lockers","Fresh Lockers","Frozen Lockers","Hospital Terminals","Indoor Terminals","Key Keeper Locker","Outdoor Terminals","University Terminals","smart terminals","Retailers Terminals"],"organizationStatus":"OPERATIONAL","organizationType":"private"}}}}}}}}},"/v1/users/{userId}":{"delete":{"tags":["User Management"],"summary":"Delete User","description":"Removes a user from the account and revokes access to all associated resources.","operationId":"removeUser","parameters":[{"name":"userId","in":"path","description":"ID of the user to be removed from the account.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"email","in":"query","description":"Email of the user performing the removal action.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"User deleted successfully. No content returned."}}}},"/v1/datasets/{datasetId}":{"delete":{"tags":["Dataset Management"],"summary":"Remove Dataset","description":"Deletes the specified dataset from the account.","operationId":"removeDataset","parameters":[{"name":"datasetId","in":"path","required":true,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Email associated with the account.","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request: The request is invalid or malformed (missing/incorrect parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1BadRequestResponse"}}}},"409":{"description":"Conflict: The request could not be completed due to a resource state conflict.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1ConflictResponse"}}}},"404":{"description":"Not Found: The requested resource does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1NotFoundResponse"}}}},"403":{"description":"Forbidden: The authenticated user does not have permission to access this resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1PermissionDenied"}}}},"500":{"description":"Interval Server Error: An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"402":{"description":"Payment Required: The client has exceeded credit limits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1InternalServerError"}}}},"429":{"description":"Too Many Requests: Rate limit exceeded. The client has sent too many requests in a given time period","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RateLimitErrorResponse"}}}},"204":{"description":"Dataset removed successfully. No content returned."}}}}},"components":{"schemas":{"RateLimitErrorResponse":{"type":"object","properties":{"timestamp":{"type":"integer","format":"int64","example":1765611454230},"status":{"type":"integer","format":"int32","example":429},"error":{"type":"string","example":"Too Many Requests"},"message":{"type":"string","example":"Rate limit exceeded. Please try again later."},"retryAfter":{"type":"integer","format":"int32","example":58},"limit":{"type":"integer","format":"int32","example":2},"remaining":{"type":"integer","format":"int32","example":0}},"description":"Rate limit exceeded error response"},"V1BadRequestResponse":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type","example":"https://developers.leadboxer.com/docs/validation-error"},"title":{"type":"string","description":"A short, human-readable summary of the problem type","example":"The request is malformed or contains invalid data"},"status":{"type":"integer","description":"The HTTP status code","format":"int32","example":400},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the problem","example":"email must be a well-formed email address"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem","example":"/v1/users/{userId}/name?email=johndoe.com"},"errors":{"type":"array","description":"Array of field-level validation errors","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"The name of the field that failed validation","example":"email"},"message":{"type":"string","description":"Human-readable error message for this specific field","example":"must be a well-formed email address"}},"description":"Array of field-level validation errors"},"V1ConflictResponse":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type","example":"Resource already exist"},"status":{"type":"integer","description":"The HTTP status code","format":"int32","example":409},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the problem","example":"User with email: john.doe@examplecompany.com already exist"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem","example":"/v1/users/?email=john.doe@examplecompany.com"}}},"V1NotFoundResponse":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type"},"status":{"type":"integer","description":"The HTTP status code","format":"int32","example":404},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the problem"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem"}}},"V1PermissionDenied":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type"},"status":{"type":"integer","description":"The HTTP status code","format":"int32","example":403},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the problem"},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem"}}},"V1InternalServerError":{"type":"object","properties":{"type":{"type":"string","description":"A URI reference that identifies the problem type"},"title":{"type":"string","description":"A short, human-readable summary of the problem type","example":"Internal Server Error"},"status":{"type":"integer","description":"The HTTP status code","format":"int32","example":500},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence of the problem","example":"An unexpected error occurred. Please contact support."},"instance":{"type":"string","description":"A URI reference that identifies the specific occurrence of the problem"}}},"ParameterizedErrorVM":{"type":"object","properties":{"message":{"type":"string"},"params":{"type":"array","items":{"type":"string"}}},"description":"Parameterized error response"},"ErrorVM":{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"},"fieldErrors":{"type":"array","items":{"$ref":"#/components/schemas/FieldErrorVM"}}}},"FieldErrorVM":{"type":"object","properties":{"objectName":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}}},"UpdateUserName":{"required":["firstName","lastName"],"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"}},"description":"The new user name details."},"UpdateSegmentRequest":{"required":["accountId","emailView","notificationType","type"],"type":"object","properties":{"accountId":{"type":"string","description":"Leadboxer accountId."},"type":{"type":"string","description":"Set visibility of the segment.<br/><br/><b>Possible values:</b><br/><b>USER</b> : the segment will be private to user.<br/><b>ACCOUNT</b> : the segment will be shared across the users of the account.","example":"USER","enum":["USER","ACCOUNT"]},"textFilter":{"type":"string","description":"Text-based filter expression used to filter result fields.Format: field|operator|value. Multiple filters are comma-separated."},"numberFilter":{"type":"string","description":"Numeric filter expression used to filter results based on numeric fields. Format: field|operator|value. Multiple filters are comma-separated. Supported numeric operators include greaterthan, lessthan, is, isnot, between, and notbetween. The between and notbetween operators use the format min-max."},"timeFilter":{"type":"string","description":"Time-based filter expression used to filter results by time field. Format: field|operator|value.\n\nAllowed fields (same as `timeField` parameter):\n- eventEsTimestamp : Last Seen\n- first_session_unix_timestamp : First Seen\n\nSupported operators:\n- exactly   → integer value (0 = Today, 1 = Yesterday)\n- lessthan  → integer value (e.g. 6 = last 7 days)\n- between   → date range in format dd/MM/yyyy-dd/MM/yyyy\n\nLocale settings are taken into account while interpreting dates and returning results."},"fieldFilter":{"type":"string","description":"Field-based filter used to include leads based on field presence.\n\nFormat:\noperator|field1;field2\n\nAllowed operator:\n- hasanyvalue\n\nAllowed fields:\n- firstName\n- lastName\n- email\n\nMultiple fields can be provided using semicolons."},"exitLinkFilter":{"type":"string","description":"Exit link filter used to include or exclude leads based on exit link values.\n\nFormat:\nfield|operator|value\n\nSupported operators:\n- contains\n- is\n- isnot\n- doesnotcontain\n\nMultiple values can be provided using semicolons.","example":"exitLinkFilter|contains|leads"},"leadscoreFilter":{"maximum":100,"minimum":0,"type":"integer","description":"Filters leads based on given minimum leadscore.","format":"int32"},"displayFilter":{"type":"string","description":"Display filter used to control which types of leads are returned.\n\nSupported values:\n- company\n- person\n- unidentified\n\nSelecting 'unidentified' returns leads that could not be identified as a company or a person.\n\nMultiple values can be provided using semicolons."},"fromFilter":{"type":"string","description":"Filters leads based on specified from user"},"owner":{"type":"string","description":"Filters leads based on specified owner"},"hidden":{"type":"string","description":"Filters leads based on presetInclusionList"},"search":{"type":"string","description":"Keyword search","example":"*"},"emailView":{"type":"string","description":"Email view type.<br/>Possible values : NONE, LEAD, ACCOUNT<br/>","example":"LEAD","enum":["NONE","LEAD","ACCOUNT"]},"notificationType":{"type":"string","description":"Set notification frequency.<br/><br/><b>Possible values:</b><br/><b>NONE</b> : Do not send any notification.<br/><b>DAILY</b> : Send notification daily.<br/><b>WEEKLY</b> : Send notification weekly.","example":"DAILY","enum":["NONE","DAILY","WEEKLY"]},"notificationMailIds":{"type":"string","description":"List of comma separated email addresses for notification","example":"user1@example.com,user2@example.com"},"mailTemplate":{"type":"string","description":"Set headlines for the notification email","example":"Weekly Lead Summary"},"format":{"type":"string","description":"Format for the segment notification.<br/>Possible values : html, csv","example":"html"},"dayOfWeek":{"type":"integer","description":"Day of week on which weekly notification will be sent. Possible values include numbers from 1 to 7 (where 1 refers to Monday)","format":"int32","example":1},"additionalCsvFields":{"type":"string","description":"List of comma separated fields to be included in CSV","example":"email,companyName,jobTitle"},"sortBy":{"type":"string","description":"Field to sort result.<br/>Possible values :<br/><b>_score</b> : records will be sorted as per leadscore.<br/><b>lastEvent</b> : records will be sorted as per activity time.<br/>Default : _score","example":"_score"},"sortOrder":{"type":"string","description":"Sort order.<br/>Possible values : asc, desc<br/>Default : desc","example":"desc"},"viewType":{"type":"string","description":"View type.<br/>Possible values : B2B, B2C<br/>Default : B2B","example":"B2B"},"timeField":{"type":"string"},"list":{"type":"string"},"csvSetName":{"type":"string"}}},"UpdateSegmentUserRequest":{"required":["segmentId","userId"],"type":"object","properties":{"segmentId":{"type":"integer","description":"Leadboxer Segment.","format":"int32"},"userId":{"type":"integer","description":"Leadboxer userId","format":"int64"}}},"SegmentPreferenceRequest":{"required":["datasetId","segmentId"],"type":"object","properties":{"datasetId":{"type":"string","description":"Dataset ID for which you need to assign segment as default."},"segmentId":{"type":"integer","description":"Segment ID which you want to assign as default.","format":"int32"},"users":{"type":"array","description":"List of User IDs for whom you need to assign a segment as default.","items":{"type":"integer","description":"List of User IDs for whom you need to assign a segment as default.","format":"int64"}}}},"LeadTagsUpdateRequest":{"required":["datasetId","leadId","leadTags"],"type":"object","properties":{"datasetId":{"type":"string"},"leadId":{"type":"string"},"leadTags":{"type":"string"}}},"CustomTrackingDomainRequest":{"required":["ctd","datasetId"],"type":"object","properties":{"ctd":{"type":"string","example":"track.companyname.com"},"datasetId":{"type":"string"},"description":{"type":"string","description":"Description for the given custom tracking domain"}}},"LeadAssignRequest":{"required":["assignee","datasetId","leadId"],"type":"object","properties":{"leadId":{"type":"string"},"datasetId":{"type":"string"},"assignee":{"type":"integer","format":"int64"}}},"AddUser":{"required":["accountId","datasetIds","email","firstName","lastName","timezone"],"type":"object","properties":{"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"accountId":{"type":"string"},"timezone":{"type":"string"},"datasetIds":{"type":"array","items":{"type":"string"}},"sendEmail":{"type":"boolean"},"clientId":{"type":"integer","format":"int64"}}},"AddUserDataset":{"required":["datasetId","timezone","userId"],"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"datasetId":{"type":"string"},"timezone":{"type":"string"},"sendEmail":{"type":"boolean"}}},"CreateSegmentRequest":{"required":["accountId","datasetId","name","type"],"type":"object","properties":{"name":{"type":"string","description":"Segment name."},"accountId":{"type":"string","description":"Leadboxer accountId."},"datasetId":{"type":"string","description":"The dataset for which to create segment."},"type":{"type":"string","description":"Defines the visibility of the segment.<br/><br/><b>Possible values:</b><br/><b>USER</b> – Visible only to the current user.<br/><b>ACCOUNT</b> – Shared with all users of the account.","example":"USER","enum":["USER","ACCOUNT"]},"textFilter":{"type":"string","description":"Text-based filter expression used to filter result fields.Format: field|operator|value. Multiple filters are comma-separated."},"numberFilter":{"type":"string","description":"Numeric filter expression used to filter results based on numeric fields. Format: field|operator|value. Multiple filters are comma-separated. Supported numeric operators include greaterthan, lessthan, is, isnot, between, and notbetween. The between and notbetween operators use the format min-max."},"timeFilter":{"type":"string","description":"Time-based filter expression used to filter results by time field. Format: field|operator|value.\n\nAllowed fields (same as `timeField` parameter):\n- eventEsTimestamp : Last Seen\n- first_session_unix_timestamp : First Seen\n\nSupported operators:\n- exactly   → integer value (0 = Today, 1 = Yesterday)\n- lessthan  → integer value (e.g. 6 = last 7 days)\n- between   → date range in format dd/MM/yyyy-dd/MM/yyyy\n\nLocale settings are taken into account while interpreting dates and returning results."},"fieldFilter":{"type":"string","description":"Field-based filter used to include leads based on field presence.\n\nFormat:\noperator|field1;field2\n\nAllowed operator:\n- hasanyvalue\n\nAllowed fields:\n- firstName\n- lastName\n- email\n\nMultiple fields can be provided using semicolons."},"exitLinkFilter":{"type":"string","description":"Exit link filter used to include or exclude leads based on exit link values.\n\nFormat:\nfield|operator|value\n\nSupported operators:\n- contains\n- is\n- isnot\n- doesnotcontain\n\nMultiple values can be provided using semicolons.","example":"exitLinkFilter|contains|leads"},"leadscoreFilter":{"maximum":100,"minimum":0,"type":"integer","description":"Filters leads based on given minimum leadscore.","format":"int32"},"displayFilter":{"type":"string","description":"Display filter used to control which types of leads are returned.\n\nSupported values:\n- company\n- person\n- unidentified\n\nSelecting 'unidentified' returns leads that could not be identified as a company or a person.\n\nMultiple values can be provided using semicolons."},"fromFilter":{"type":"string","description":"Filters leads based on specified from user"},"owner":{"type":"string","description":"Filters leads based specified owner(userId)"},"hidden":{"type":"string","description":"Filters leads based on presetInclusionList"},"search":{"type":"string","description":"Keyword search."},"emailView":{"type":"string","description":"Email view type.<br/>Possible values : NONE, LEAD, ACCOUNT<br/>","example":"LEAD","default":"NONE","enum":["NONE","LEAD","ACCOUNT"]},"notificationType":{"type":"string","description":"Set notification frequency.<br/><br/><b>Possible values:</b><br/><b>NONE</b> : Do not send any notification.<br/><b>DAILY</b> : Send notification daily.<br/><b>WEEKLY</b> : Send notification weekly.","example":"DAILY","enum":["NONE","DAILY","WEEKLY"]},"notificationMailIds":{"type":"string","description":"List of comma separated email addresses for notification.","example":"user1@example.com,user2@example.com"},"mailTemplate":{"type":"string","description":"Set headlines for the notification email.","example":"Weekly Lead Summary"},"format":{"type":"string","description":"Format for the segment notification.<br/>Possible values : html, csv","example":"html"},"dayOfWeek":{"type":"integer","description":"Day of week on which weekly notification will be sent. Possible values include numbers from 1 to 7 (where 1 refers to Monday).","format":"int32","example":1},"additionalCsvFields":{"type":"string","description":"List of comma separated fields to be included in CSV.","example":"email,companyName,jobTitle"},"sortBy":{"type":"string","description":"Field to sort result.<br/>Possible values :<br/><b>_score</b> : records sorted by leadscore.<br/><b>lastEvent</b> : records sorted by activity time.<br/>Default : _score","example":"_score"},"sortOrder":{"type":"string","description":"Sort order.<br/>Possible values : asc, desc<br/>Default : desc","example":"desc"},"viewType":{"type":"string","description":"View type.<br/>Possible values : B2B, B2C<br/>Default : B2B","example":"B2B"},"list":{"type":"string","description":"Filters list file saved using List Settings Page."},"timeField":{"type":"string"},"csvSetName":{"type":"string"}}},"CreateResponseDTOInteger":{"type":"object","properties":{"id":{"type":"integer","format":"int32"}}},"CTDSuggestionDTO":{"type":"object","properties":{"type":{"type":"string","description":"The DNS record type that should be configured for the custom tracking domain. This is typically a CNAME record required for tracking and link redirection.","example":"CNAME"},"host":{"type":"string","description":"Tracking subdomain where the DNS record should be configured.","example":"track"},"value":{"type":"string","description":"Target hostname that the tracking subdomain must point to.","example":"pixel.leadboxer.com"}},"description":"A recommended DNS record configuration generated after validating the custom tracking domain"},"CustomTrackingDomainValidationResponse":{"type":"object","properties":{"responseCode":{"type":"integer","format":"int32"},"responseMessage":{"type":"string"},"messageType":{"type":"string","description":"Indicates the result of custom tracking domain validation.\n\n- ERROR: Validation failed due to a client-side or server-side error.\n- WARNING: The domain is valid, but the DNS configuration is incomplete. Suggested CNAME records are returned.\n- SUCCESS: The domain is valid and correctly configured for tracking."},"suggestions":{"type":"array","description":"Recommended DNS record configurations needed to complete custom tracking domain setup.","items":{"$ref":"#/components/schemas/CTDSuggestionDTO"}}},"description":"Represents the response returned after validating a custom tracking domain. The response indicates whether validation failed, succeeded, or requires additional DNS configuration, and may include suggested CNAME records to complete setup."},"ContactEnrichmentRequest":{"required":["email"],"type":"object","properties":{"email":{"maxLength":254,"minLength":0,"type":"string","description":"Email address of the contact to enrich","example":"jane.doe@leadboxer.com"},"firstName":{"maxLength":100,"minLength":0,"type":"string","description":"First name of the contact","example":"Jane"},"lastName":{"maxLength":100,"minLength":0,"type":"string","description":"Last name of the contact","example":"Doe"},"companyName":{"maxLength":200,"minLength":0,"type":"string","description":"Name of the company the contact works for","example":"LeadBoxer"},"companyDomain":{"maxLength":253,"minLength":0,"type":"string","description":"Domain of the company the contact works for","example":"leadboxer.com"}},"description":"Contact enrichment request. Only the email is required; the other fields are optional hints that improve matching."},"ContactProfileDetails":{"type":"object","properties":{"email":{"type":"string","description":"Email address that was looked up","example":"jane.doe@leadboxer.com"},"fullName":{"type":"string","description":"Full name of the contact","example":"Jane Doe"},"headline":{"type":"string","description":"Profile headline","example":"Head of Marketing at LeadBoxer"},"linkedinUrl":{"type":"string","description":"LinkedIn profile URL","example":"https://www.linkedin.com/in/janedoe"},"seniority":{"type":"string","description":"Seniority level","example":"Senior"},"jobFunction":{"type":"string","description":"Job function","example":"Marketing"},"location":{"type":"string","description":"Location of the contact","example":"Amsterdam, North Holland, Netherlands"},"languages":{"type":"array","description":"Languages the contact speaks","items":{"$ref":"#/components/schemas/Language"}},"experience":{"type":"array","description":"Work experience, most recent first","items":{"$ref":"#/components/schemas/Experience"}}},"description":"Professional profile of a contact, returned when the email address is matched"},"Experience":{"type":"object","properties":{"title":{"type":"string","description":"Job title","example":"Head of Marketing"},"companyName":{"type":"string","description":"Company name","example":"LeadBoxer"},"startYear":{"type":"integer","description":"Start year","format":"int32","example":2021},"endYear":{"type":"integer","description":"End year, empty for the current position","format":"int32","example":2024},"current":{"type":"boolean","description":"Whether this is a current position","example":true}},"description":"Work experience, most recent first"},"Language":{"type":"object","properties":{"name":{"type":"string","description":"Language name","example":"English"},"proficiency":{"type":"string","description":"Proficiency level","example":"Native or bilingual proficiency"}},"description":"Languages the contact speaks"},"AddDataset":{"required":["humanName","timezone"],"type":"object","properties":{"humanName":{"type":"string"},"timezone":{"type":"string"},"userIds":{"type":"array","items":{"type":"integer","format":"int64"}},"emails":{"type":"array","items":{"type":"string"}},"sendEmail":{"type":"boolean"}}},"CreateResponseDTOString":{"type":"object","properties":{"id":{"type":"string"}}},"SaveDatasetExclusion":{"required":["data","datasetId","type"],"type":"object","properties":{"datasetId":{"type":"string"},"type":{"type":"string","enum":["use_id","organizationName","organizationDomain","last_most_likely_company"]},"data":{"type":"string"}}},"CreditUsageTimeSeriesRequest":{"required":["accountId","from","to"],"type":"object","properties":{"accountId":{"type":"string"},"from":{"type":"string"},"to":{"type":"string"},"timezone":{"type":"string"},"datasets":{"type":"array","items":{"type":"string"}},"categories":{"type":"array","items":{"type":"string"}},"operations":{"type":"array","items":{"type":"integer","format":"int32"}}}},"DailyUsage":{"type":"object","properties":{"usageDate":{"type":"string","format":"date"},"creditsUsed":{"type":"integer","format":"int64"},"overageCredits":{"type":"integer","format":"int64"}}},"GetAllResponseDailyUsage":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DailyUsage"}},"metaData":{"type":"object"}}},"CreditUsageSummaryRequest":{"required":["accountId","from","to"],"type":"object","properties":{"accountId":{"type":"string"},"from":{"type":"string","format":"date-time"},"to":{"type":"string","format":"date-time"}}},"CreditUsageSummary":{"type":"object","properties":{"available":{"type":"integer","format":"int64"},"total":{"type":"integer","format":"int64"},"creditsUsed":{"type":"integer","format":"int64"},"creditsOverage":{"type":"integer","format":"int64"},"isUnlimited":{"type":"boolean"}}},"GetAllResponseUserDatasetDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/UserDatasetDTO"}},"metaData":{"type":"object"}}},"UserDatasetDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"humanName":{"type":"string"},"timezone":{"type":"string"},"formTracking":{"type":"boolean"},"partialFormTracking":{"type":"boolean"},"contactEnrichmentEnabled":{"type":"boolean"},"formInputAttribute":{"type":"string"},"allowIpMasking":{"type":"boolean"},"apiKey":{"type":"string"},"accessToken":{"type":"string"},"createdTimestamp":{"type":"string","format":"date-time"}}},"AccountUserDTO":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"email":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"role":{"type":"string"},"lastLogin":{"type":"string","format":"date-time"},"unixTimeEndActiveDate":{"type":"integer","format":"int64"},"client":{"$ref":"#/components/schemas/ClientDTO"},"uiRole":{"type":"integer","format":"int64"}}},"AccountUserDatasetDTO":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/AccountUserDTO"},"site":{"$ref":"#/components/schemas/UserDatasetDTO"}}},"BaseUserDTO":{"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"}}},"ClientDTO":{"type":"object","properties":{"clientId":{"type":"integer","format":"int64"},"clientName":{"type":"string"},"smartlistId":{"type":"integer","format":"int32"},"createdTimestamp":{"type":"string","format":"date-time"},"modifiedTimestamp":{"type":"string","format":"date-time"},"users":{"type":"array","items":{"$ref":"#/components/schemas/BaseUserDTO"}}}},"GetAllResponseAccountUserDatasetDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AccountUserDatasetDTO"}},"metaData":{"type":"object"}}},"GetAllResponseSmartlistDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SmartlistDTO"}},"metaData":{"type":"object"}}},"SmartlistDTO":{"type":"object","properties":{"smartlistId":{"type":"integer","format":"int32"},"userId":{"type":"integer","format":"int64"},"textFilter":{"type":"string"},"eventFilter":{"type":"string"},"numberFilter":{"type":"string"},"timeFilter":{"type":"string"},"fieldFilter":{"type":"string"},"exitLinkFilter":{"type":"string"},"leadscoreFilter":{"type":"integer","format":"int32"},"displayFilter":{"type":"string"},"fromFilter":{"type":"string"},"owner":{"type":"string"},"hidden":{"type":"string"},"search":{"type":"string"},"name":{"type":"string"},"createdTimestamp":{"type":"string","format":"date-time"},"modifiedTimestamp":{"type":"string","format":"date-time"},"type":{"type":"string"},"accountId":{"type":"string"},"notificationType":{"type":"string"},"notificationMailIds":{"type":"string"},"mailTemplate":{"type":"string"},"format":{"type":"string"},"dayOfWeek":{"type":"integer","format":"int32"},"additionalCsvFields":{"type":"string"},"datasetId":{"type":"string"},"sortBy":{"type":"string"},"sortOrder":{"type":"string"},"viewType":{"type":"string"},"timeField":{"type":"string"},"emailView":{"type":"string"},"list":{"type":"string"},"csvSetName":{"type":"string"},"default":{"type":"boolean"},"favourite":{"type":"boolean"}}},"GetAllResponseLong":{"type":"object","properties":{"data":{"type":"array","items":{"type":"integer","format":"int64"}},"metaData":{"type":"object"}}},"CustomTrackingDomainDTO":{"type":"object","properties":{"datasetId":{"type":"string"},"ctd":{"type":"string"},"createdTimestamp":{"type":"integer","format":"int64"},"modifiedTimestamp":{"type":"integer","format":"int64"},"description":{"type":"string"}}},"GetAllResponseCustomTrackingDomainDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomTrackingDomainDTO"}},"metaData":{"type":"object"}}},"CreditGrantDTO":{"type":"object","properties":{"creditsGranted":{"type":"integer","format":"int64"},"creditsUsed":{"type":"integer","format":"int64"},"creditsAvailable":{"type":"integer","format":"int64"},"source":{"type":"string"},"effectiveAt":{"type":"string"},"expiresAt":{"type":"string"}}},"GetAllResponseCreditGrantDTO":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CreditGrantDTO"}},"metaData":{"type":"object"}}},"GetAllResponse":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object"}},"metaData":{"type":"object"}}},"GetAllResponseMapStringObject":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"type":"object"}}},"metaData":{"type":"object"}}},"IpLookupDetails":{"type":"object","properties":{"ipRange":{"type":"string","description":"CIDR range in which the searched IP address belongs","example":"193.8.9.0/24"},"ipCountryCode":{"type":"string","description":"ISO 3166-1 alpha-2 country code of the IP address","example":"CH"},"ipCountryName":{"type":"string","description":"Full country name where the IP address is registered","example":"Switzerland"},"ipSubContinent":{"type":"string","description":"Sub-continent or geographical region of the IP address","example":"Western Europe"},"ipRegionName":{"type":"string","description":"Administrative region or state of the IP address","example":"Basel-Stadt"},"ipCity":{"type":"string","description":"City associated with the IP address","example":"Basel"},"ipLatitude":{"type":"string","description":"Latitude coordinate of the IP address location","example":"47.5586"},"ipLongitude":{"type":"string","description":"Longitude coordinate of the IP address location","example":"7.57401"},"ipTimezone":{"type":"string","description":"Timezone corresponding to the IP address location","example":"Europe/Zurich"},"ipIsp":{"type":"string","description":"Internet Service Provider associated with the IP address","example":"BNP Paribas S.A."},"ipOrganization":{"type":"string","description":"Registered organization or entity owning the IP address","example":"BNP Paribas S.A."},"ipDomain":{"type":"string","description":"Primary domain name associated with the IP address","example":"group.bnpparibas"},"ipUsageType":{"type":"string","description":"Usage classification of the IP address","example":"COM","enum":["COM","RES","MOB","DC","EDU","GOV"]},"searchIp":{"type":"string","description":"IP address that was queried in the lookup request","example":"193.8.9.0"},"searchResponseTimeMs":{"type":"integer","description":"Time taken to resolve the IP lookup, in milliseconds","format":"int64","example":165}},"description":"Resolved IP metadata returned when an IP address is successfully identified"},"DomainOrganizationDetails":{"type":"object","properties":{"organizationName":{"type":"string"},"organizationType":{"type":"string"},"organizationStatus":{"type":"string"},"organizationDomain":{"type":"string"},"organizationDomainAliases":{"type":"array","items":{"type":"string"}},"organizationIndustryCode":{"type":"string"},"organizationIndustryGroup":{"type":"string"},"organizationIndustryName":{"type":"string"},"organizationEmployeeCountRangeCode":{"type":"string"},"organizationEmployeeCountRangeName":{"type":"string"},"organizationSource":{"type":"string"},"organizationReportDate":{"type":"string"},"organizationDescription":{"type":"string"},"organizationDescriptionShort":{"type":"string"},"organizationSpecialties":{"type":"array","items":{"type":"string"}},"organizationAddress":{"$ref":"#/components/schemas/OrganizationAddress"},"organizationSocialLinks":{"$ref":"#/components/schemas/OrganizationSocialLinks"}},"description":"Organization details resolved from domain"},"OrganizationAddress":{"type":"object","properties":{"organizationStreetName":{"type":"string"},"organizationCity":{"type":"string"},"organizationState":{"type":"string"},"organizationPostalCode":{"type":"string"},"organizationCountry":{"type":"string"},"organizationCountryCode":{"type":"string"},"organizationPhone":{"type":"string"}},"description":"Organization address details"},"OrganizationSocialLinks":{"type":"object","properties":{"organizationLinkedinUrl":{"type":"string"}},"description":"Organization social links"},"DatasetTypeExclusionResponse":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"array","items":{"type":"string"}}}},"GetAllResponseDatasetTypeExclusionResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DatasetTypeExclusionResponse"}},"metaData":{"type":"object"}}},"RemoveUserDataset":{"required":["datasetId","userId"],"type":"object","properties":{"userId":{"type":"integer","format":"int64"},"datasetId":{"type":"string"}}},"RemoveDatasetExclusion":{"required":["data","datasetId","type"],"type":"object","properties":{"type":{"type":"string"},"data":{"type":"string"},"datasetId":{"type":"string"}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","description":"Provide your LeadBoxer API Key","name":"x-api-key","in":"header"}}}}