Enterprise

Organizations, API keys, source templates, proxy profiles, suppression lists, and data destinations

Endpoints (32)

GET/api/organizations

Auth Required

List Organizations

Get all organizations the current user belongs to.

POST/api/organizations

Auth Required

Create Organization

Create a new organization.

GET/api/organizations/{id}

Auth Required

Get Organization

Get organization details.

GET/api/organizations/{id}/members

Auth Required

List Members

Get all members of an organization.

POST/api/organizations/{id}/members

Auth Required

Invite Member

Invite an existing account to the organization by email (ADMIN role required). The account is NOT a member until it accepts the invitation, and until then it does not appear in the member list. The response is identical whether or not the address has an account, is already a member, or was already invited. Session only: an API key cannot call this.

PATCH/api/organizations/{id}/members

Auth Required

Change Member Role

Change an active member's role (ADMIN role required). The owner and the last remaining admin cannot be demoted. Session only.

DELETE/api/organizations/{id}/members

Auth Required

Remove Member

Remove a member (ADMIN role required, or a member removing themselves) by the userId query parameter, or withdraw a pending invitation by the email query parameter (ADMIN only; answers the same whether or not one existed). The owner and the last remaining admin cannot be removed. Session only.

GET/api/organizations/invitations

Auth Required

My Invitations

Invitations waiting for the signed-in user's answer.

POST/api/organizations/{id}/invitation

Auth Required

Accept or Decline an Invitation

The invitee's answer to a pending invitation. Accepting is what makes the caller a member. Session only.

GET/api/organizations/{id}/sso

Auth Required

SSO Configuration

Get the organization's SSO configuration (null when none is configured).

POST/api/organizations/{id}/sso

Auth Required

Configure SSO

Set the organization's SSO provider (ADMIN role required). Returns the stored configuration.

GET/api/organizations/{id}/scim

Auth Required

SCIM Configuration

Get the organization's SCIM provisioning config (null when none). The bearer token is never returned.

POST/api/organizations/{id}/scim

Auth Required

Configure SCIM

Set the SCIM bearer token the identity provider will use (ADMIN role required). Returns the config without the token.

GET/api/organizations/{id}/defaults

Auth Required

Organization Defaults

Get the organization's default settings (branding).

PATCH/api/organizations/{id}/defaults

Auth Required

Update Organization Defaults

Update the organization's default settings (ADMIN role required).

GET/api/organizations/{id}/ip-allowlist

Auth Required

IP Allowlist

List the organization's IP allowlist entries. Once any entry exists, org routes refuse requests from outside the allowlist.

POST/api/organizations/{id}/ip-allowlist

Auth Required

Add IP Allowlist Entry

Add a CIDR range to the allowlist (ADMIN role required).

DELETE/api/organizations/{id}/ip-allowlist

Auth Required

Remove IP Allowlist Entry

Remove an allowlist entry by id (ADMIN role required). The entry is named by the entryId query parameter.

GET/api/api-keys

Auth Required

List API Keys

Get all API keys for programmatic access.

POST/api/api-keys

Auth Required

Create API Key

Generate a new API key. The full key is returned only once.

DELETE/api/api-keys/{id}

Auth Required

Delete API Key

Revoke an API key.

POST/api/mcp

Auth Required

Hosted MCP Server

Stateless Model Context Protocol endpoint (Streamable HTTP) for external AI agents. Authenticate with an sk_ API key (Authorization: Bearer). Registers the API-backed tools plus the browser_* cloud-browser toolset and send_chat_message; tool calls proxy to Scrappy's REST API as the key's user, scoped and rate-limited like any API call. POST only (GET/DELETE → 405).

GET/api/source-templates

Auth Required

List Source Templates

Get reusable source configuration templates.

GET/api/source-templates/marketplace

Auth Required

Template Marketplace

Browse publicly shared source templates from other users.

POST/api/source-templates

Auth Required

Create Source Template

Create a reusable source configuration template.

GET/api/proxy-profiles

Auth Required

List Proxy Profiles

Get configured proxy profiles for scraping.

POST/api/proxy-profiles

Auth Required

Create Proxy Profile

Add a proxy profile for use in scraping jobs.

GET/api/suppression-list

Auth Required

List Suppression Lists

Get email suppression lists for compliance.

GET/api/suppression-list/{id}/entries

Auth Required

List Suppression Entries

Get entries in a suppression list.

GET/api/data-destinations

Auth Required

List Data Destinations

Get configured data sync destinations (webhooks, databases, CRMs).

POST/api/data-destinations

Auth Required

Create Data Destination

Configure a new data sync destination.

POST/api/data-destinations/{id}/sync

Auth Required

Trigger Sync

Manually trigger a data sync to a destination.