Takedowns List

List takedowns for an organization. Authenticate with an API key (the org is derived from the key) or with a user session (pass organizationSlug in the request body).

POST /takedowns/list

List takedowns

cURL

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/takedowns/list \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "organizationSlug": "<string>",
  "query": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "assetType": [],
  "takedownStatus": [],
  "livenessStatus": [],
  "brandIds": [
    1
  ],
  "assigneeIds": [
    1
  ],
  "startedAtStartDate": "<string>",
  "startedAtEndDate": "<string>",
  "hideAutomatedTakedowns": true,
  "hideAutomatedLivenessChecks": true,
  "sorting": [
    {}
  ],
  "per_page": 10,
  "next_page": "<string>"
}
'

200

{
  "takedowns": [
    {
      "id": 123,
      "externalId": "<string>",
      "hasFilingDelay": true,
      "hasLivenessCheckDelay": true,
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "asset": {
        "id": 123,
        "content": "<string>",
        "blockedAt": "<string>"
      },
      "assignee": {
        "id": 123,
        "fullName": "<string>"
      },
      "brand": {
        "id": 123,
        "name": "<string>",
        "slug": "<string>"
      },
      "domainRegistrar": {
        "id": 123,
        "name": "<string>"
      },
      "hostingProvider": {
        "id": 123,
        "name": "<string>"
      },
      "tldRegistrar": {
        "id": 123,
        "name": "<string>"
      }
    }
  ],
  "next_page": "<string>"
}

This API requires an API key with appropriate permissions. See API Key Documentation for more details.

This endpoint uses cursor-based pagination for efficient retrieval of large datasets. If you encounter errors related to payload size, please use the pagination feature as described below.

Pagination

To use pagination, include the per_page and next_page parameters in your request:

• per_page <number>: Number of takedowns to return per page (min: 1, max: 100)
• next_page <string>: Cursor for the next page of results

Example implementation for pagination:

JavaScript

async function fetchAllTakedowns() {
  let allTakedowns = [];
  let nextPage = null;
  while (true) {
    const response = await fetch(
      "https://app.chainpatrol.io/api/v2/takedowns/list",
      {
        method: "POST",
        headers: {
          "Content-Type": "application/json",
          "X-API-KEY": "YOUR_API_KEY_HERE",
        },
        body: JSON.stringify({
          per_page: 100,
          next_page: nextPage,
          takedownStatus: ["TODO", "IN_PROGRESS"],
          livenessStatus: ["ALIVE"],
        }),
      }
    );
    const data = await response.json();
    allTakedowns = allTakedowns.concat(data.takedowns);
    nextPage = data.next_page;
    if (!nextPage) {
      break;
    }
  }
  return allTakedowns;
}
fetchAllTakedowns()
  .then((takedowns) => console.log("All takedowns:", takedowns))
  .catch((error) => console.error("Error fetching takedowns:", error));

Authorizations

X-API-KEY · string · header · required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at [e-mail] to get an API key for your use.

Body

application/json

List takedowns request body

Defaults to getting all takedowns in the last 30 days.

You can also choose a startDate and endDate for the range of takedown updates, most timestamp formats should work, we use Luxon for parsing the dates.

organizationSlug · string

Organization slug. Required when authenticating with a user session (Bearer token); ignored when using an API key (org is derived from the key).

query · string

Search query to filter takedowns by asset content

startDate · string

The start date to list takedowns from. This should be in the format YYYY-MM-DD and is inclusive.

endDate · string

The end date to list takedowns to. This should be in the format YYYY-MM-DD and is inclusive.

assetType · enum<string>[]

Filter by asset types

Available options: URL, PAGE, ADDRESS, DISCORD, LINKEDIN, TWITTER, FACEBOOK, YOUTUBE, REDDIT, TELEGRAM, GOOGLE_APP_STORE, APPLE_APP_STORE, AMAZON_APP_STORE, MICROSOFT_APP_STORE, TIKTOK, INSTAGRAM, THREADS, MEDIUM, CHROME_WEB_STORE, MOZILLA_ADDONS, OPERA_ADDONS, EMAIL, PATREON, OPENSEA, FARCASTER, IPFS, GOOGLE_FORM, WHATSAPP, DISCORD_USER, QUORA, GITHUB, TEACHABLE, SUBSTACK, DEBANK, TAWK_TO, JOTFORM, PRIMAL, BLUESKY, SNAPCHAT, DESO, PINTEREST, FLICKR, GALXE, VELOG, NPM, PYPI, HEX, DOCKER_HUB, VOCAL_MEDIA, TECKFINE, TENDERLY, HACKMD, ETSY, ZAZZLE, BASENAME, BILIBILI_TV, VIMEO, DAILYMOTION, PHONE_NUMBER, SLACK, CALENDLY, NGROK, RARIBLE, RUST_PACKAGE, FLATHUB, VIDLII, VEVIOZ, ISSUU, SOUNDCLOUD, ZAPPER, REDNOTE, SAMSUNG_APP_STORE, HUAWEI_APP_STORE, XIAOMI_APP_STORE, TENCENT_APP_STORE, OPPO_APP_STORE, VIVO_APP_STORE, F_DROID, GOOGLE_AD, BING_AD, TWITCH, BEHANCE, ZORA, META_AD, SIGNAL, DEVIANTART, BANDCAMP, ARCHIVE_ORG, FIVE_HUNDRED_PX, LUMA, SMARTMONEYMATCH, APK_GOLD

takedownStatus · enum<string>[]

Filter by takedown status

Available options: TODO, IN_PROGRESS, COMPLETED, CANCELLED, PENDING_RETRACTION, RETRACTION_SENT, RETRACTED, PENDING_INPUT, PENDING_EVIDENCE

livenessStatus · enum<string>[]

Filter by liveness status

Available options: UNKNOWN, ALIVE, DEAD

brandIds · integer[]

Filter by brand IDs

Required range: x > 0

assigneeIds · integer[]

Filter by takedown assignee user IDs

Required range: x > 0

startedAtStartDate · string

Inclusive start of the takedown started at date range, in YYYY-MM-DD or ISO 8601. A takedown's started-at is the earliest IN_PROGRESS status-change event.

startedAtEndDate · string

Inclusive end of the takedown started at date range. Defaults to the current time when startedAtStartDate is provided alone.

hideAutomatedTakedowns · boolean

Hide takedowns whose target asset type (or content) is handled by the automated platform-takedown pipeline (e.g. Telegram, Medium, *.webflow.io).

hideAutomatedLivenessChecks · boolean

Hide takedowns whose asset type (or content) is checked for liveness automatically (e.g. Twitter, Bluesky, *.gitbook.io).

sorting · object[]

Sorting configuration

Show child attributes

per_page · integer · default: 10

The number of takedowns to return per page

Required range: 1 <= x <= 100

next_page · string | null

Cursor for fetching the next page of results

Response

200

application/json

Successful response

Successful operation

takedowns · object[] · required

List of takedowns

Show child attributes

next_page · string | null

Cursor for fetching the next page of results