AlterLabAlterLab
PricingComparePlaygroundBlogDocsChangelog
    AlterLabAlterLab
    PricingComparePlaygroundBlogDocsChangelog
    IntroductionQuickstartInstallationYour First Request
    REST APIJob PollingAPI KeysSessions APINew
    OverviewPythonNode.js
    JavaScript RenderingOutput FormatsPDF & OCRCachingWebhooksJSON Schema FilteringWebSocket Real-TimeBring Your Own ProxyProAuthenticated ScrapingNewWeb CrawlingBatch ScrapingSchedulerChange DetectionCloud Storage ExportSpend LimitsOrganizations & TeamsAlerts & Notifications
    Structured ExtractionAIE-commerce ScrapingNews MonitoringPrice MonitoringMulti-Page CrawlingMonitoring DashboardAI Agent / MCPMCPData Pipeline to Cloud
    PricingRate LimitsError Codes
    From FirecrawlFrom ApifyFrom ScrapingBee / ScraperAPIFirecrawl v0 API ReferenceLegacy
    PlaygroundPricingStatus
    API Reference
    Auto-generated

    Organizations

    API reference for organizations endpoints.

    Auto-generated

    This page was generated from the OpenAPI spec. Runmake generate-docs to refresh after spec changes.

    GET /api/v1/organizations

    GET
    /api/v1/organizations

    List Organizations

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/organizations \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "organizations": []
    }

    POST /api/v1/organizations

    POST
    /api/v1/organizations

    Create Organization

    Parameters

    NameTypeRequiredDescription
    namestring
    Required
    Name
    descriptionstringOptionaldescription

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/organizations \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "name": "example_name"
      }'

    Response Example

    JSON
    {
      "status": "ok"
    }

    GET /api/v1/organizations/default

    GET
    /api/v1/organizations/default

    Get Default Organization

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/organizations/default \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "default_organization": "example"
    }

    POST /api/v1/organizations/default

    POST
    /api/v1/organizations/default

    Set Default Organization

    Parameters

    NameTypeRequiredDescription
    organization_idstring
    Required
    Organization Id

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/organizations/default \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "organization_id": "example_organization_id"
      }'

    Response Example

    JSON
    {
      "default_organization": "example"
    }

    GET /api/v1/organizations/invitations/{token}

    GET
    /api/v1/organizations/invitations/{token}

    Get Invitation By Token

    Parameters

    NameTypeRequiredDescription
    tokenstring
    Required
    token

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/organizations/invitations/<token> \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "id": "example",
      "organization_name": "example",
      "organization_avatar_url": "example",
      "role": "example",
      "invited_by_name": "example",
      "invited_by_email": "example"
    }

    POST /api/v1/organizations/invitations/{token}/accept

    POST
    /api/v1/organizations/invitations/{token}/accept

    Accept Invitation

    Parameters

    NameTypeRequiredDescription
    tokenstring
    Required
    token

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/organizations/invitations/<token>/accept \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "message": "example",
      "organization": "example"
    }

    POST /api/v1/organizations/invitations/{token}/decline

    POST
    /api/v1/organizations/invitations/{token}/decline

    Decline Invitation

    Parameters

    NameTypeRequiredDescription
    tokenstring
    Required
    token

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/organizations/invitations/<token>/decline \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "status": "ok"
    }

    GET /api/v1/organizations/{org_id}

    GET
    /api/v1/organizations/{org_id}

    Get Organization

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/organizations/<org_id> \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "id": "example",
      "name": "example",
      "slug": "example",
      "description": "example",
      "avatar_url": "example",
      "is_personal": true
    }

    PATCH /api/v1/organizations/{org_id}

    PATCH
    /api/v1/organizations/{org_id}

    Update Organization

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    X-Organization-IdstringOptionalX-Organization-Id
    namestringOptionalname
    descriptionstringOptionaldescription
    avatar_urlstringOptionalavatar_url
    settingsobjectOptionalsettings

    Request Example

    Bash
    curl -X PATCH https://api.alterlab.io/api/v1/organizations/<org_id> \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "id": "example",
      "name": "example",
      "slug": "example",
      "description": "example",
      "avatar_url": "example",
      "is_personal": true
    }

    DELETE /api/v1/organizations/{org_id}

    DELETE
    /api/v1/organizations/{org_id}

    Delete Organization

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    X-Organization-IdstringOptionalX-Organization-Id

    Request Example

    Bash
    curl -X DELETE https://api.alterlab.io/api/v1/organizations/<org_id> \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "status": "ok"
    }

    GET /api/v1/organizations/{org_id}/audit-logs

    GET
    /api/v1/organizations/{org_id}/audit-logs

    Get Organization Audit Logs

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    actionstringOptionalFilter by action type
    actor_idstringOptionalFilter by actor
    limitintegerOptionalNumber of entries to returnDefault: 50
    offsetintegerOptionalNumber of entries to skipDefault: 0
    X-Organization-IdstringOptionalX-Organization-Id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/organizations/<org_id>/audit-logs \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "logs": [],
      "total": 0,
      "limit": 0,
      "offset": 0
    }

    POST /api/v1/organizations/{org_id}/invitations

    POST
    /api/v1/organizations/{org_id}/invitations

    Create Invitation

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    X-Organization-IdstringOptionalX-Organization-Id
    emailstring
    Required
    Email
    role"owner" | "admin" | "member"OptionalOrganization member roles.

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/organizations/<org_id>/invitations \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "email": "example_email"
      }'

    Response Example

    JSON
    {
      "status": "ok"
    }

    GET /api/v1/organizations/{org_id}/invitations

    GET
    /api/v1/organizations/{org_id}/invitations

    List Invitations

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    X-Organization-IdstringOptionalX-Organization-Id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/organizations/<org_id>/invitations \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "invitations": []
    }

    DELETE /api/v1/organizations/{org_id}/invitations/{invitation_id}

    DELETE
    /api/v1/organizations/{org_id}/invitations/{invitation_id}

    Cancel Invitation

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    invitation_idstring
    Required
    invitation_id
    X-Organization-IdstringOptionalX-Organization-Id

    Request Example

    Bash
    curl -X DELETE https://api.alterlab.io/api/v1/organizations/<org_id>/invitations/<invitation_id> \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "status": "ok"
    }

    POST /api/v1/organizations/{org_id}/invitations/{invitation_id}/resend

    POST
    /api/v1/organizations/{org_id}/invitations/{invitation_id}/resend

    Resend Invitation

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    invitation_idstring
    Required
    invitation_id
    X-Organization-IdstringOptionalX-Organization-Id

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/organizations/<org_id>/invitations/<invitation_id>/resend \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "id": "example",
      "organization_id": "example",
      "organization_name": "example",
      "email": "example",
      "role": "example",
      "invited_by": "example"
    }

    POST /api/v1/organizations/{org_id}/leave

    POST
    /api/v1/organizations/{org_id}/leave

    Leave Organization

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/organizations/<org_id>/leave \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "status": "ok"
    }

    GET /api/v1/organizations/{org_id}/members

    GET
    /api/v1/organizations/{org_id}/members

    List Members

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    pageintegerOptionalpageDefault: 1
    page_sizeintegerOptionalpage_sizeDefault: 50

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/organizations/<org_id>/members \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "members": [],
      "total": 0
    }

    PATCH /api/v1/organizations/{org_id}/members/{member_user_id}

    PATCH
    /api/v1/organizations/{org_id}/members/{member_user_id}

    Update Member Role

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    member_user_idstring
    Required
    member_user_id
    X-Organization-IdstringOptionalX-Organization-Id
    role"owner" | "admin" | "member"
    Required
    Organization member roles.

    Request Example

    Bash
    curl -X PATCH https://api.alterlab.io/api/v1/organizations/<org_id>/members/<member_user_id> \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "role": "..."
      }'

    Response Example

    JSON
    {
      "id": "example",
      "organization_id": "example",
      "user": "example",
      "role": "example",
      "joined_at": "example",
      "invited_by": "example"
    }

    DELETE /api/v1/organizations/{org_id}/members/{member_user_id}

    DELETE
    /api/v1/organizations/{org_id}/members/{member_user_id}

    Remove Member

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    member_user_idstring
    Required
    member_user_id
    X-Organization-IdstringOptionalX-Organization-Id

    Request Example

    Bash
    curl -X DELETE https://api.alterlab.io/api/v1/organizations/<org_id>/members/<member_user_id> \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "status": "ok"
    }

    GET /api/v1/organizations/{org_id}/stats

    GET
    /api/v1/organizations/{org_id}/stats

    Get Organization Stats

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id

    Request Example

    Bash
    curl -X GET https://api.alterlab.io/api/v1/organizations/<org_id>/stats \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json"

    Response Example

    JSON
    {
      "total_members": 0,
      "total_api_keys": 0,
      "total_webhooks": 0,
      "credits_used_this_period": 0,
      "credits_allocated": 0,
      "subscription_tier": "example"
    }

    POST /api/v1/organizations/{org_id}/transfer-ownership

    POST
    /api/v1/organizations/{org_id}/transfer-ownership

    Transfer Ownership

    Parameters

    NameTypeRequiredDescription
    org_idstring
    Required
    org_id
    X-Organization-IdstringOptionalX-Organization-Id
    new_owner_idstring
    Required
    New Owner Id

    Request Example

    Bash
    curl -X POST https://api.alterlab.io/api/v1/organizations/<org_id>/transfer-ownership \
      -H "X-API-Key: YOUR_API_KEY" \
      -H "Content-Type: application/json" \
      -d '{
        "new_owner_id": "example_new_owner_id"
      }'

    Response Example

    JSON
    {
      "message": "example",
      "new_owner": "example",
      "former_owner_new_role": "example"
    }
    Last updated: March 2026

    On this page