Get user organizations

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/user/orgs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "query": "",
  "subscriptionStatus": [],
  "services": {
    "reporting": {
      "active": true
    },
    "reviewing": {
      "active": true
    },
    "protection": {
      "active": true
    },
    "takedowns": {
      "active": true,
      "automated": true
    },
    "detection": {
      "active": true
    },
    "darkWebMonitoring": {
      "active": true
    }
  },
  "obligatoryAdminApproval": {
    "active": true,
    "assetTypes": []
  },
  "pendingServiceApproval": {
    "active": true,
    "services": []
  }
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/user/orgs"

payload = {
    "query": "",
    "subscriptionStatus": [],
    "services": {
        "reporting": { "active": True },
        "reviewing": { "active": True },
        "protection": { "active": True },
        "takedowns": {
            "active": True,
            "automated": True
        },
        "detection": { "active": True },
        "darkWebMonitoring": { "active": True }
    },
    "obligatoryAdminApproval": {
        "active": True,
        "assetTypes": []
    },
    "pendingServiceApproval": {
        "active": True,
        "services": []
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '',
    subscriptionStatus: [],
    services: {
      reporting: {active: true},
      reviewing: {active: true},
      protection: {active: true},
      takedowns: {active: true, automated: true},
      detection: {active: true},
      darkWebMonitoring: {active: true}
    },
    obligatoryAdminApproval: {active: true, assetTypes: []},
    pendingServiceApproval: {active: true, services: []}
  })
};

fetch('https://app.chainpatrol.io/api/v2/user/orgs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chainpatrol.io/api/v2/user/orgs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '',
    'subscriptionStatus' => [
        
    ],
    'services' => [
        'reporting' => [
                'active' => true
        ],
        'reviewing' => [
                'active' => true
        ],
        'protection' => [
                'active' => true
        ],
        'takedowns' => [
                'active' => true,
                'automated' => true
        ],
        'detection' => [
                'active' => true
        ],
        'darkWebMonitoring' => [
                'active' => true
        ]
    ],
    'obligatoryAdminApproval' => [
        'active' => true,
        'assetTypes' => [
                
        ]
    ],
    'pendingServiceApproval' => [
        'active' => true,
        'services' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/user/orgs"

	payload := strings.NewReader("{\n  \"query\": \"\",\n  \"subscriptionStatus\": [],\n  \"services\": {\n    \"reporting\": {\n      \"active\": true\n    },\n    \"reviewing\": {\n      \"active\": true\n    },\n    \"protection\": {\n      \"active\": true\n    },\n    \"takedowns\": {\n      \"active\": true,\n      \"automated\": true\n    },\n    \"detection\": {\n      \"active\": true\n    },\n    \"darkWebMonitoring\": {\n      \"active\": true\n    }\n  },\n  \"obligatoryAdminApproval\": {\n    \"active\": true,\n    \"assetTypes\": []\n  },\n  \"pendingServiceApproval\": {\n    \"active\": true,\n    \"services\": []\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/user/orgs")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"\",\n  \"subscriptionStatus\": [],\n  \"services\": {\n    \"reporting\": {\n      \"active\": true\n    },\n    \"reviewing\": {\n      \"active\": true\n    },\n    \"protection\": {\n      \"active\": true\n    },\n    \"takedowns\": {\n      \"active\": true,\n      \"automated\": true\n    },\n    \"detection\": {\n      \"active\": true\n    },\n    \"darkWebMonitoring\": {\n      \"active\": true\n    }\n  },\n  \"obligatoryAdminApproval\": {\n    \"active\": true,\n    \"assetTypes\": []\n  },\n  \"pendingServiceApproval\": {\n    \"active\": true,\n    \"services\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/user/orgs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"\",\n  \"subscriptionStatus\": [],\n  \"services\": {\n    \"reporting\": {\n      \"active\": true\n    },\n    \"reviewing\": {\n      \"active\": true\n    },\n    \"protection\": {\n      \"active\": true\n    },\n    \"takedowns\": {\n      \"active\": true,\n      \"automated\": true\n    },\n    \"detection\": {\n      \"active\": true\n    },\n    \"darkWebMonitoring\": {\n      \"active\": true\n    }\n  },\n  \"obligatoryAdminApproval\": {\n    \"active\": true,\n    \"assetTypes\": []\n  },\n  \"pendingServiceApproval\": {\n    \"active\": true,\n    \"services\": []\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "organizations": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>",
      "avatarUrl": "<string>",
      "contactUrl": "<string>",
      "brandMetadata": {
        "websiteUrl": "<string>",
        "twitterHandle": "<string>",
        "securityContactEmail": "<string>",
        "industry": "<string>"
      },
      "portalCustomization": {
        "useCustomDetails": true,
        "name": "<string>",
        "slug": "<string>",
        "avatarUrl": "<string>",
        "bannerEnabled": true,
        "bannerContent": "<string>"
      },
      "services": {
        "reporting": {
          "active": true
        },
        "reviewing": {
          "active": true
        },
        "protection": {
          "active": true
        },
        "takedowns": {
          "active": true,
          "automated": true
        },
        "detection": {
          "active": true
        },
        "darkWebMonitoring": {
          "active": true
        }
      },
      "integrations": {
        "slack": true,
        "discord": true,
        "telegram": {
          "connected": true,
          "groupCount": 123
        },
        "vercel": true,
        "intercom": true,
        "moderation": true
      },
      "obligatoryAdminApproval": {
        "active": true,
        "assetTypes": []
      },
      "pendingServiceApprovals": [
        {
          "automated": true,
          "serviceName": "<string>",
          "requestedAt": "<string>"
        }
      ],
      "legalDocuments": {
        "letterOfAuthorization": {
          "present": true,
          "fileName": "<string>",
          "fileUrl": "<string>"
        },
        "powerOfAttorney": {
          "present": true,
          "fileName": "<string>",
          "fileUrl": "<string>"
        }
      },
      "trademarkRegistrations": [
        {
          "id": 123,
          "brandName": "<string>",
          "trademarkOffice": "<string>",
          "registrationNumber": "<string>",
          "goodsAndServicesClass": "<string>",
          "rightsOwnerName": "<string>",
          "registrationPageUrl": "<string>",
          "certificateFileName": "<string>",
          "certificateFileUrl": "<string>"
        }
      ]
    }
  ]
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Account & Access

List User Organizations

List organizations accessible to the current user along with each org’s subscription status, which services (reporting, reviewing, protection, takedowns, detection, dark web monitoring) are enabled, integration connection status (Slack, Discord, Telegram, Vercel, Intercom, Moderation API), whether Obligatory Organization Admin Approval is enabled, the org-level Letter of Authorization / Power of Attorney attachments, and every org-level trademark registration on file. Each service exposes an active flag; only takedowns additionally exposes automated. The integrations object shows which third-party integrations are connected: slack, discord, vercel, intercom, and moderation are booleans; telegram is { connected, groupCount } since an org can have multiple Telegram groups. The legalDocuments block has letterOfAuthorization and powerOfAttorney entries, each with { present, fileName, fileUrl }. trademarkRegistrations is the full list of org-level trademarks with their issuing office, registration number, and (when uploaded) a certificateFileUrl link — use it to identify which customers have or have not added trademarks. Optional subscriptionStatus, services, and obligatoryAdminApproval filters narrow the result server-side. INACTIVE orgs are always excluded.

POST

user

orgs

Get user organizations

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/user/orgs \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "query": "",
  "subscriptionStatus": [],
  "services": {
    "reporting": {
      "active": true
    },
    "reviewing": {
      "active": true
    },
    "protection": {
      "active": true
    },
    "takedowns": {
      "active": true,
      "automated": true
    },
    "detection": {
      "active": true
    },
    "darkWebMonitoring": {
      "active": true
    }
  },
  "obligatoryAdminApproval": {
    "active": true,
    "assetTypes": []
  },
  "pendingServiceApproval": {
    "active": true,
    "services": []
  }
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/user/orgs"

payload = {
    "query": "",
    "subscriptionStatus": [],
    "services": {
        "reporting": { "active": True },
        "reviewing": { "active": True },
        "protection": { "active": True },
        "takedowns": {
            "active": True,
            "automated": True
        },
        "detection": { "active": True },
        "darkWebMonitoring": { "active": True }
    },
    "obligatoryAdminApproval": {
        "active": True,
        "assetTypes": []
    },
    "pendingServiceApproval": {
        "active": True,
        "services": []
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    query: '',
    subscriptionStatus: [],
    services: {
      reporting: {active: true},
      reviewing: {active: true},
      protection: {active: true},
      takedowns: {active: true, automated: true},
      detection: {active: true},
      darkWebMonitoring: {active: true}
    },
    obligatoryAdminApproval: {active: true, assetTypes: []},
    pendingServiceApproval: {active: true, services: []}
  })
};

fetch('https://app.chainpatrol.io/api/v2/user/orgs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.chainpatrol.io/api/v2/user/orgs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'query' => '',
    'subscriptionStatus' => [
        
    ],
    'services' => [
        'reporting' => [
                'active' => true
        ],
        'reviewing' => [
                'active' => true
        ],
        'protection' => [
                'active' => true
        ],
        'takedowns' => [
                'active' => true,
                'automated' => true
        ],
        'detection' => [
                'active' => true
        ],
        'darkWebMonitoring' => [
                'active' => true
        ]
    ],
    'obligatoryAdminApproval' => [
        'active' => true,
        'assetTypes' => [
                
        ]
    ],
    'pendingServiceApproval' => [
        'active' => true,
        'services' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/user/orgs"

	payload := strings.NewReader("{\n  \"query\": \"\",\n  \"subscriptionStatus\": [],\n  \"services\": {\n    \"reporting\": {\n      \"active\": true\n    },\n    \"reviewing\": {\n      \"active\": true\n    },\n    \"protection\": {\n      \"active\": true\n    },\n    \"takedowns\": {\n      \"active\": true,\n      \"automated\": true\n    },\n    \"detection\": {\n      \"active\": true\n    },\n    \"darkWebMonitoring\": {\n      \"active\": true\n    }\n  },\n  \"obligatoryAdminApproval\": {\n    \"active\": true,\n    \"assetTypes\": []\n  },\n  \"pendingServiceApproval\": {\n    \"active\": true,\n    \"services\": []\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.chainpatrol.io/api/v2/user/orgs")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"query\": \"\",\n  \"subscriptionStatus\": [],\n  \"services\": {\n    \"reporting\": {\n      \"active\": true\n    },\n    \"reviewing\": {\n      \"active\": true\n    },\n    \"protection\": {\n      \"active\": true\n    },\n    \"takedowns\": {\n      \"active\": true,\n      \"automated\": true\n    },\n    \"detection\": {\n      \"active\": true\n    },\n    \"darkWebMonitoring\": {\n      \"active\": true\n    }\n  },\n  \"obligatoryAdminApproval\": {\n    \"active\": true,\n    \"assetTypes\": []\n  },\n  \"pendingServiceApproval\": {\n    \"active\": true,\n    \"services\": []\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/user/orgs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"query\": \"\",\n  \"subscriptionStatus\": [],\n  \"services\": {\n    \"reporting\": {\n      \"active\": true\n    },\n    \"reviewing\": {\n      \"active\": true\n    },\n    \"protection\": {\n      \"active\": true\n    },\n    \"takedowns\": {\n      \"active\": true,\n      \"automated\": true\n    },\n    \"detection\": {\n      \"active\": true\n    },\n    \"darkWebMonitoring\": {\n      \"active\": true\n    }\n  },\n  \"obligatoryAdminApproval\": {\n    \"active\": true,\n    \"assetTypes\": []\n  },\n  \"pendingServiceApproval\": {\n    \"active\": true,\n    \"services\": []\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "organizations": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>",
      "avatarUrl": "<string>",
      "contactUrl": "<string>",
      "brandMetadata": {
        "websiteUrl": "<string>",
        "twitterHandle": "<string>",
        "securityContactEmail": "<string>",
        "industry": "<string>"
      },
      "portalCustomization": {
        "useCustomDetails": true,
        "name": "<string>",
        "slug": "<string>",
        "avatarUrl": "<string>",
        "bannerEnabled": true,
        "bannerContent": "<string>"
      },
      "services": {
        "reporting": {
          "active": true
        },
        "reviewing": {
          "active": true
        },
        "protection": {
          "active": true
        },
        "takedowns": {
          "active": true,
          "automated": true
        },
        "detection": {
          "active": true
        },
        "darkWebMonitoring": {
          "active": true
        }
      },
      "integrations": {
        "slack": true,
        "discord": true,
        "telegram": {
          "connected": true,
          "groupCount": 123
        },
        "vercel": true,
        "intercom": true,
        "moderation": true
      },
      "obligatoryAdminApproval": {
        "active": true,
        "assetTypes": []
      },
      "pendingServiceApprovals": [
        {
          "automated": true,
          "serviceName": "<string>",
          "requestedAt": "<string>"
        }
      ],
      "legalDocuments": {
        "letterOfAuthorization": {
          "present": true,
          "fileName": "<string>",
          "fileUrl": "<string>"
        },
        "powerOfAttorney": {
          "present": true,
          "fileName": "<string>",
          "fileUrl": "<string>"
        }
      },
      "trademarkRegistrations": [
        {
          "id": 123,
          "brandName": "<string>",
          "trademarkOffice": "<string>",
          "registrationNumber": "<string>",
          "goodsAndServicesClass": "<string>",
          "rightsOwnerName": "<string>",
          "registrationPageUrl": "<string>",
          "certificateFileName": "<string>",
          "certificateFileUrl": "<string>"
        }
      ]
    }
  ]
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Overview

List the organizations accessible to the current user, along with each one’s subscription status, which services are enabled (reporting, reviewing, protection, takedowns, detection, and dark web monitoring), integration connection status, whether obligatory organization admin approval is enabled, the org-level Letter of Authorization and Power of Attorney attachments, and every org-level trademark registration on file.

Notes

Every service exposes an active flag; only takedowns additionally exposes automated.
The integrations object reports which third-party integrations are connected. slack, discord, vercel, intercom, and moderation are booleans; telegram reports both a connected flag and a group count, since an organization can have multiple Telegram groups.
legalDocuments has letterOfAuthorization and powerOfAttorney entries, each reporting whether the document is present along with its file name and URL.
trademarkRegistrations is the full list of org-level trademarks with their issuing office, registration number, and a certificate PDF link when one has been uploaded — use it to identify which customers have or have not added trademarks.
The optional subscriptionStatus, services, and obligatoryAdminApproval filters narrow the result server-side. INACTIVE organizations are always excluded.

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 support@chainpatrol.io to get an API key for your use.

Body

application/json

query

string

default:""

subscriptionStatus

enum<string>[]

Minimum array length: 1

Available options:

PROSPECT,

POC,

ACTIVE,

INTEGRATION

services

object

Show child attributes

obligatoryAdminApproval

object

Show child attributes

pendingServiceApproval

object

Show child attributes

Response

Successful response

organizations

object[]

required

Show child attributes

Update Current User

Get User Organization

⌘I

External API

Assets

Blocklist Sync

Organization Assets

Organization Asset Groups

Organization Brands

Reports

Organization Reports

Threats

Disputes

Takedowns

Organization Metrics

Operations

Healthchecks

Account & Access

Webhooks

List User Organizations

Overview

Notes

Authorizations

Body

Response

​Overview

​Notes

Authorizations

Body

Response

Overview

Notes