> For the complete documentation index, see [llms.txt](https://detected.gitbook.io/detected-api-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://detected.gitbook.io/detected-api-docs/api-reference/alerts.md). # Alerts Alerts are raised when something about a profile changes and may need a review: a new or updated screening hit (for example a sanctions or adverse media match), a change to the company data, a change to the profile's review status, or the profile being assigned to a user. Analysts review alerts in the case management application and acknowledge or clear them. ## List alerts > Returns all alerts raised in the account, most recent first. Use the query parameters to filter the results for specific statuses or profiles. ```json {"openapi":"3.0.0","info":{"title":"Detected API","version":"v2"},"tags":[{"name":"Alerts","description":"Alerts are raised when something about a profile changes and may need a review: a new or updated screening hit (for example a sanctions or adverse media match), a change to the company data, a change to the profile's review status, or the profile being assigned to a user. Analysts review alerts in the case management application and acknowledge or clear them."}],"servers":[{"url":"https://api.detected.app/api/v2/public","description":"Production"}],"security":[{"AccessToken":[]}],"components":{"securitySchemes":{"AccessToken":{"type":"http","description":"The API uses OAuth 2.0. Request an access token with **Create an access token** (`POST /oauth/token`), sending the client ID and client secret of your integration client, and your account slug. Send the access token in the `Authorization` header of every request, in the format `Authorization: Bearer `. The access token carries the scopes set on your integration client in the dashboard. Access tokens expire. When one expires, request a new one.","bearerFormat":"OAuth 2.0 access token","scheme":"bearer"}},"parameters":{"page":{"name":"page","in":"query","description":"Page number of the results to return, starting from 1. The number of items per page is returned in `meta.per_page`.","schema":{"type":"integer","minimum":1}}},"headers":{"X-RateLimit-Limit":{"description":"Maximum number of requests allowed in the rate limit window.","schema":{"type":"number","nullable":false}},"X-RateLimit-Remaining":{"description":"Number of requests remaining in the current rate limit window.","schema":{"type":"number","nullable":false}},"Retry-After":{"description":"Number of seconds to wait before making another request. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}},"X-RateLimit-Reset":{"description":"Unix timestamp (in seconds) at which the rate limit resets. Returned when the rate limit has been reached.","schema":{"type":"number","nullable":false}}},"schemas":{"ProfileNotificationAlertsResourceResponse":{"title":"Profile Notification Alerts Resource Response","properties":{"id":{"description":"Alert ID.","type":"integer","nullable":false},"profile_id":{"description":"UUID of the profile the alert belongs to.","type":"string","format":"uuid","nullable":false},"attribute":{"description":"What caused the alert, for example `New Sanction`, `UpdatedAdverse Media`, `ProfileStatusSetToNeedsReview`, `DirectorRemoved` or `ProfileAssigned`.","type":"string","nullable":false},"change":{"description":"Details of the change. What it contains depends on `attribute`: profile status changes have the `previous` and `current` status; screening hits have the entity `name` and the number of hits in each category, for example `\"Sanction\": 2`; company data changes have the `path` of the data that changed, with its `previous` and `current` values; profile assignments have the `user_id` of the assigned user.","type":"object","additionalProperties":true},"acknowledged":{"description":"Acknowledgement status of the alert: `acknowledged` if a user has acknowledged it, `cleared` if a user has cleared it, or `null` if neither.","type":"string","enum":["acknowledged","cleared"],"nullable":true},"acknowledged_by":{"description":"Name of the user who acknowledged or cleared the alert, or `null` if neither. May also be `null` on older alerts.","type":"string","nullable":true},"acknowledged_at":{"description":"Date and time the alert was acknowledged or cleared, or `null` if neither. This date has no timezone.","type":"string","nullable":true},"created_at":{"description":"Date and time the alert was created.","type":"string","format":"date-time","nullable":false}},"type":"object"},"LinksResource":{"title":"Links Resource","properties":{"first":{"description":"URL of the first page of results.","type":"string","nullable":false},"last":{"description":"URL of the last page of results.","type":"string","nullable":false},"prev":{"description":"URL of the previous page of results, or null if there is none.","type":"string","nullable":true},"next":{"description":"URL of the next page of results, or null if there is none.","type":"string","nullable":true}},"type":"object"},"MetaResource":{"title":"Meta Resource","properties":{"current_page":{"description":"Number of the current page.","type":"integer","nullable":false},"from":{"description":"Position of the first item on this page, counted across all pages, or `null` if there are no results.","type":"integer","nullable":true},"last_page":{"description":"Number of the last page.","type":"integer","nullable":false},"links":{"description":"Pagination links, including links to the previous and next pages.","type":"array","items":{"properties":{"url":{"description":"URL of the page, or `null` if there is no such page.","type":"string","nullable":true},"label":{"description":"Text to display for the link, for example a page number or \"Previous\".","type":"string","nullable":false},"page":{"description":"Number of the page the link points to, or `null` if there is no such page.","type":"integer","nullable":true},"active":{"description":"Whether this link is for the current page.","type":"boolean","nullable":false}},"type":"object"},"nullable":false},"path":{"description":"Base URL of the endpoint, without query parameters.","type":"string","nullable":false},"per_page":{"description":"Number of items per page.","type":"integer","nullable":false},"to":{"description":"Position of the last item on this page, counted across all pages, or `null` if there are no results.","type":"integer","nullable":true},"total":{"description":"Total number of items across all pages.","type":"integer","nullable":false}},"type":"object"}},"responses":{"401":{"description":"Unauthorized. The access token is missing, invalid or has expired.","content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}},"422":{"description":"Unprocessable Content. The request was understood but failed validation. `errors` lists each field that failed and why.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"A human-readable description of the first error.","type":"string"},"errors":{"description":"Validation errors, keyed by the name of the field that failed. Each field has a list of messages.","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}},"429":{"description":"Too Many Requests. You have exceeded the rate limit. Wait for the number of seconds given in the `Retry-After` header before trying again.","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"Retry-After":{"$ref":"#/components/headers/Retry-After"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"properties":{"message":{"description":"A human-readable description of the error.","type":"string"}},"type":"object"}}}}}},"paths":{"/alerts":{"get":{"tags":["Alerts"],"summary":"List alerts","description":"Returns all alerts raised in the account, most recent first. Use the query parameters to filter the results for specific statuses or profiles.","operationId":"213e4567141ad581b2643849c1c1d25e","parameters":[{"$ref":"#/components/parameters/page"},{"name":"acknowledged","in":"query","description":"Filter by acknowledgement status. Only `cleared` is supported, which returns the alerts a user has cleared.","required":false,"schema":{"type":"string","enum":["cleared"]}},{"name":"profile_id","in":"query","description":"Filter by profile UUID.","required":false,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"}},"content":{"application/json":{"schema":{"properties":{"data":{"description":"List of alerts","type":"array","items":{"$ref":"#/components/schemas/ProfileNotificationAlertsResourceResponse"}},"links":{"$ref":"#/components/schemas/LinksResource"},"meta":{"$ref":"#/components/schemas/MetaResource"}},"type":"object"}}}},"401":{"$ref":"#/components/responses/401"},"422":{"$ref":"#/components/responses/422"},"429":{"$ref":"#/components/responses/429"}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://detected.gitbook.io/detected-api-docs/api-reference/alerts.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.