> ## Documentation Index > Fetch the complete documentation index at: https://chainpatrol.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # orgs command — list and inspect organizations > List ChainPatrol organizations by subscription status, service toggles, and pending approvals, then inspect one org, its allowlist, watchlist, and brands. ```bash theme={null} chainpatrol orgs |assets list|assets set-expiry|asset-groups list> ``` `orgs list` and `orgs get` operate on the organizations your credential can see. The nested subcommands — `assets` and `asset-groups` — operate on the organization tied to your API key. ## orgs list List organizations with their subscription status and per-service active flag. All filters compose with AND. | Option | Description | | - | - | | `--query ` | Partial name match (substring, case-insensitive). | | `--subscription-status ` | Comma list: `PROSPECT`, `POC`, `ACTIVE`, `INTEGRATION`, `PROTECTION`, `INACTIVE`. Defaults to every status except `INACTIVE`; pass `INACTIVE` to list churned organizations. | | `--service-active ` | Comma list of services that must be active. | | `--service-inactive ` | Comma list of services that must be inactive. | | `--service-automated ` | Services whose automation must be **on**. Only `takedowns` is accepted. | | `--service-manual ` | Services whose automation must be **off**. Only `takedowns` is accepted. | | `--pending-approval-active` | Only organizations with an open service-enable approval awaiting sign-off. | | `--pending-approval-inactive` | Only organizations with no pending service-enable approvals. | | `--pending-approval-service ` | Only organizations with a pending approval for `protection` (Blocklisting) and/or `takedowns`. | | `--obligatory-approval-active` | Only organizations with [Obligatory Organization Admin Approval](https://chainpatrol.com/docs/concepts/organizations.md#obligatory-organization-admin-approval) turned on. | | `--obligatory-approval-inactive` | Only organizations with it turned off. Can't be combined with `--obligatory-approval-active` or `--obligatory-approval-asset-type`. | | `--obligatory-approval-asset-type ` | Comma list of asset types. Only organizations where the approval is on and covers every listed type. An organization with no types selected counts as covering all of them. | Services are `reporting`, `reviewing`, `protection`, `takedowns`, `detection`, and `darkWebMonitoring`. `automated` is reported for takedowns only — that is the one service where manual-versus-automated changes real platform behavior. ```bash theme={null} chainpatrol orgs list --subscription-status ACTIVE chainpatrol orgs list --service-active takedowns --service-manual takedowns chainpatrol --json orgs list --subscription-status ACTIVE,POC --service-active detection chainpatrol --json orgs list --pending-approval-service protection,takedowns ``` ## orgs get Get a single organization by slug. Returns the same shape as one row of `orgs list`. ```bash theme={null} chainpatrol orgs get ``` | Option | Description | | - | - | | `--org ` | Use the saved default organization instead of a positional argument. | The caller must have access: an organization-scoped API key must match the slug, and a user session or key needs an active membership unless the user is staff. ```bash theme={null} chainpatrol orgs get acme chainpatrol --json orgs get acme chainpatrol orgs get acme --output markdown ``` ## orgs assets list List the assets in your organization's allowlist. The organization is derived from your API key. | Option | Description | | - | - | | `--asset-type ` | Filter by asset type (`URL`, `ADDRESS`, …). `--type` is an alias. | | `--group-id ` | Filter by group ID. Use `-1` for ungrouped assets only. | | `--query ` | Search asset content (substring). | | `--per-page ` | Page size, 1–1000. Defaults to 100. `--limit` is also accepted. | | `--next-page ` | Cursor returned by a previous response. | ```bash theme={null} chainpatrol orgs assets list --asset-type URL chainpatrol orgs assets list --group-id 12 --per-page 250 --output csv ``` Each asset with an expiry shows `expires=`; CSV and JSON output include `allowlistExpiresAt` and `allowlistExpiredAt`. ## orgs assets set-expiry Set, renew or clear when assets drop off your organization's allowlist. After the expiry passes, assets stay on your organization for a 14-day grace period, then are removed from it; their status does not change. See [Expiry](https://chainpatrol.com/docs/concepts/allowlist.md#expiry). Pass one or more asset IDs (from `orgs assets list`) and exactly one of `--expires`, `--in` or `--clear`. Needs an organization API key with write access, or an organization owner or admin. | Option | Description | | - | - | | `--expires ` | Expiry date. `YYYY-MM-DD` expires at the end of that day (UTC); an ISO date-time is used as given. | | `--in ` | Expire after a duration from today: `30d`, `6m`, `1y`. Expires at the end of that day (UTC). | | `--clear` | Remove the expiry so the assets stay indefinitely. | | `--id ` | Asset ID. Repeatable; positional and comma-separated IDs also work. | | `--org ` | Organization slug. Omit it with an organization-scoped API key. | | `--dry-run` | Show what would change without changing it. | ```bash theme={null} chainpatrol orgs assets set-expiry 12345 12346 --in 6m chainpatrol orgs assets set-expiry 12345 --expires 2027-04-30 chainpatrol orgs assets set-expiry 12345 --clear --org acme ``` ## orgs watchlist list List the assets ChainPatrol is watching for your organization: ones you reported that were not blocked (dead, parked, not enough evidence, …) and are re-scanned so they can be blocked later. It is the same set the `threatsWatchlisted` metric counts. Pass `--org `, or omit it to use the organization tied to your API key. | Option | Description | | - | - | | `--asset-type ` | Filter by asset type (`URL`, `TWITTER`, …). `--type` is an alias. | | `--query ` | Search asset content (substring). | | `--from ` / `--to ` | Only assets your organization reported in this window. | | `--include-total` | Also print the total number of watchlisted assets. | | `--per-page ` | Page size, 1–1000. Defaults to 100. `--limit` is also accepted. | | `--next-page ` | Cursor returned by a previous response. | ```bash theme={null} chainpatrol orgs watchlist list --include-total chainpatrol orgs watchlist list --org acme --asset-type URL --output csv ``` See [`GET /organization/watchlist`](https://chainpatrol.com/docs/external-api/organization-watchlist-list) for every field in the response. ## orgs asset-groups list List your organization's asset groups with per-group asset counts. ```bash theme={null} chainpatrol orgs asset-groups list chainpatrol orgs asset-groups list --output csv ``` ## brands list `brands` is a separate top-level command that lists the brands available to you. ```bash theme={null} chainpatrol brands list [--type ORGANIZATION|INDIVIDUAL|PRODUCT] ``` The `--type` value is case-insensitive. Brand IDs from this listing are what `--brand` and `--brand-id` accept elsewhere — in [`reports list`](https://chainpatrol.com/docs/cli/commands/reports#reports-list), [`detections list`](https://chainpatrol.com/docs/cli/commands/detections#detections-list), [`takedowns list`](https://chainpatrol.com/docs/cli/commands/takedowns), [`metrics`](https://chainpatrol.com/docs/cli/commands/metrics), and [`proposals review`](https://chainpatrol.com/docs/cli/commands/proposals). ```bash theme={null} chainpatrol brands list chainpatrol brands list --type ORGANIZATION chainpatrol --json brands list | jq '.brands[] | {id, name}' ``` ## Related * [`GET /organization/assets`](https://chainpatrol.com/docs/external-api/organization-assets-list) * [`GET /organization/asset-groups`](https://chainpatrol.com/docs/external-api/organization-asset-groups-list) * [`GET /organization/brands`](https://chainpatrol.com/docs/external-api/organization-brands) * [Organizations concept](https://chainpatrol.com/docs/concepts/organizations.md) and [Brands concept](https://chainpatrol.com/docs/concepts/brands.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.