> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clustr-ai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Request Erasure

> Remove one person from every workspace of your organization: their paths (as prospect or
connector), engagement links, notes and workspace prospects. Your CRM data
stays as it is. Each workspace's connected warehouses get an immediate export pass, and a `person.erased` webhook is sent when it is done.

It runs in the background: the answer is `202` with the erasure. Read its progress with
Get Erasure. Asking again for a person whose erasure is still pending or running, or
repeating an `Idempotency-Key`, returns that erasure with `200`.

**Scope:** `erasures:write`. Ask for it when your key is created.




## OpenAPI

````yaml /enterprise/openapi.yaml post /erasures
openapi: 3.1.0
info:
  title: Clustr Organization API
  description: >
    Organization-level operations for partners who run Clustr for many clients:
    workspaces, the

    signed webhook, usage and contract limits, erasure and the audit log.


    This API covers the organization only. Everything a workspace does (imports,
    jobs, search,

    saved views, tags) is the public API at
    `https://api.clustr-ai.com/api/public`, called with the

    organization key and an `X-Clustr-Tenant` header.


    ## Authentication

    Every endpoint needs an organization API key (it starts with `clo_`) in the

    `Authorization` header.


    ```

    Authorization: Bearer clo_...

    ```


    Clustr staff create organization keys. Each key carries scopes; an operation
    that needs a

    scope the key lacks answers `403`.
  version: '1.0'
  contact:
    name: Clustr Support
    url: https://clustr-ai.com
servers:
  - url: https://api.clustr-ai.com/api/org/v1
    description: Production
security:
  - OrgKey: []
tags:
  - name: Workspaces
    description: >-
      Create, read, rename, suspend, resume and delete the workspaces of your
      organization.
  - name: Webhook
    description: The organization's signed webhook, its secret and its deliveries.
  - name: Usage and limits
    description: >-
      What your organization used, the monthly statement, and your contract
      limits.
  - name: Erasure
    description: Remove one person from every workspace of the organization.
  - name: Audit log
    description: The organization's own record of every call.
paths:
  /erasures:
    post:
      tags:
        - Erasure
      summary: Request Erasure
      description: >
        Remove one person from every workspace of your organization: their paths
        (as prospect or

        connector), engagement links, notes and workspace prospects. Your CRM
        data

        stays as it is. Each workspace's connected warehouses get an immediate
        export pass, and a `person.erased` webhook is sent when it is done.


        It runs in the background: the answer is `202` with the erasure. Read
        its progress with

        Get Erasure. Asking again for a person whose erasure is still pending or
        running, or

        repeating an `Idempotency-Key`, returns that erasure with `200`.


        **Scope:** `erasures:write`. Ask for it when your key is created.
      operationId: requestErasure
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ErasureRequest'
            examples:
              by_url:
                summary: By LinkedIn URL
                value:
                  linkedin_url: https://www.linkedin.com/in/jane-doe
                  gdpr_subject: false
      responses:
        '200':
          description: >-
            The same person is already being erased, or the `Idempotency-Key`
            was used before. The answer is that existing erasure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErasureResponse'
        '202':
          description: The erasure was recorded and will run in the background.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErasureResponse'
              example:
                success: true
                data:
                  id: 9b2f4a1c-6d3e-4f7a-8c5b-2e1d0f9a7c63
                  status: pending
                  linkedin_url: https://www.linkedin.com/in/jane-doe
                  gdpr_subject: false
                  tenants_total: 0
                  tenants_done: 0
                  profile_erased: false
                  tenants: []
                  created_at: '2026-10-14T10:00:00Z'
        '400':
          description: >-
            Neither `linkedin_url` nor `person_id` names a person, the body is
            not a JSON object, or the `Idempotency-Key` is over 200 characters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                error:
                  code: BAD_REQUEST
                  message: Give linkedin_url or person_id.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '502':
          $ref: '#/components/responses/BadGateway'
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Your own key for this request, 1 to 200 characters. Repeating it returns
        the erasure the first request made.
      schema:
        type: string
        minLength: 1
        maxLength: 200
      example: erase-jane-2026-10
  schemas:
    ErasureRequest:
      type: object
      description: Give `linkedin_url` or `person_id`.
      properties:
        linkedin_url:
          type: string
          description: The person's LinkedIn profile URL, or its slug.
          example: https://www.linkedin.com/in/jane-doe
        person_id:
          type: string
          description: A person id from Clustr, or a LinkedIn member id.
        gdpr_subject:
          type: boolean
          default: false
          description: >-
            `true` only when this is the person's own GDPR erasure request.
            Their profile is then erased from Clustr entirely.
    ErasureResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Erasure'
    ErrorResponse:
      type: object
      description: >-
        Every error has this shape. Branch on `error.code`; `error.message` is
        for people.
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: >-
                A stable code to branch on, such as `BAD_REQUEST`, `NOT_FOUND`
                or `CONFLICT`.
              example: BAD_REQUEST
            message:
              type: string
              description: A sentence a person can read.
              example: Invalid request body.
            request_id:
              type: string
              description: Quote it to Clustr support.
    Erasure:
      type: object
      required:
        - id
        - status
        - gdpr_subject
        - tenants_total
        - tenants_done
        - profile_erased
        - tenants
        - created_at
      properties:
        id:
          type: string
          format: uuid
          example: 9b2f4a1c-6d3e-4f7a-8c5b-2e1d0f9a7c63
        status:
          type: string
          enum:
            - pending
            - running
            - done
            - failed
        linkedin_url:
          type: string
          example: https://www.linkedin.com/in/jane-doe
        person_id:
          type: string
        gdpr_subject:
          type: boolean
        tenants_total:
          type: integer
          example: 3
        tenants_done:
          type: integer
          example: 0
        profile_erased:
          type: boolean
          description: The shared profile rows were erased (only with `gdpr_subject`).
        tenants:
          type: array
          description: What was removed in each workspace so far.
          items:
            $ref: '#/components/schemas/ErasureTenantResult'
        error:
          type: string
          description: Set when the erasure failed. Quote the erasure id to Clustr support.
        created_at:
          type: string
          format: date-time
        completed_at:
          type: string
          format: date-time
    ErasureTenantResult:
      type: object
      required:
        - tenant_id
        - deleted
      properties:
        tenant_id:
          type: string
          format: uuid
        deleted:
          type: object
          description: Rows removed, by kind.
          additionalProperties:
            type: integer
            format: int64
          example:
            opportunities: 14
            notes: 1
        exports_triggered:
          type: array
          description: The destinations an immediate export pass was requested for.
          items:
            type: string
          example:
            - snowflake
        error:
          type: string
  responses:
    Unauthorized:
      description: >-
        The key is missing, invalid or revoked, or it is not an organization
        key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UNAUTHORIZED
              message: Invalid or revoked API key
    Forbidden:
      description: The key lacks the scope this operation needs.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: FORBIDDEN
              message: This key lacks the tenants:write scope
    TooManyRequests:
      description: >-
        Your organization is over its rate limit. The limit is shared by all
        keys and workspaces of the organization. Wait for `Retry-After`, then
        retry.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: RATE_LIMITED
              message: Too many requests
    BadGateway:
      description: The organization service could not be reached. Retry later.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            success: false
            error:
              code: UPSTREAM_UNAVAILABLE
              message: The organization service is unavailable
  headers:
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
    RateLimitLimit:
      description: Requests per second allowed for your organization.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current window. Always `0` on a `429`.
      schema:
        type: integer
    RateLimitReset:
      description: Unix time (seconds) when requests are allowed again.
      schema:
        type: integer
  securitySchemes:
    OrgKey:
      type: http
      scheme: bearer
      description: >-
        Organization API key (`clo_...`). The `X-API-Key` header is also
        accepted in place of `Authorization: Bearer`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.