---
updatedAt: 2026-09-25T15:14:44.000Z
agentTools:
  projectIndex: https://docs.attentive.com/llms.txt
---

# Get the status of the most recent clear-segment operation

Returns the status of the most recent clear-segment operation for the segment identified by its external ID. The response includes the processing status, timestamps, and a failure reason if applicable.

Only segments created via the Public API can be queried using this endpoint.

Scopes Required: [segments:Read]

Default Rate Limit: 100 requests per second


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "description": "For any questions, reach out to your Attentive point of contact (if applicable) or [api@attentivemobile.com](mailto:api@attentivemobile.com).",
    "title": "Attentive API V2",
    "version": "2.0.0"
  },
  "servers": [
    {
      "url": "https://api.attentivemobile.com/",
      "description": "Attentive API V2"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    }
  ],
  "tags": [
    {
      "name": "Segments",
      "description": "Endpoints for submitting bulk segment member additions and removals. Use these endpoints to manage segment memberships in bulk and monitor the processing status asynchronously.\n\n## Processing Times\n\nThe Bulk API processes jobs with the following targets:\n- **Standard Processing**: The first 10,000 records per day per customer typically complete within 4 hours of request acceptance.\n- **High-Volume Processing**: Additional records beyond 10,000 per day typically complete within 12 hours.\n\n**Note**: For jobs with more than 1 million records, processing times may vary.\n",
      "x-beta": true
    }
  ],
  "paths": {
    "/v2/segments/external/{externalId}/clear-segment/status": {
      "x-external": "hidden",
      "x-requires-auth": true,
      "get": {
        "x-external": true,
        "x-requires-auth": true,
        "security": [
          {
            "bearerAuth": []
          },
          {
            "OAuthFlow": [
              "segments:read"
            ]
          }
        ],
        "summary": "Get the status of the most recent clear-segment operation",
        "description": "Returns the status of the most recent clear-segment operation for the segment identified by its external ID. The response includes the processing status, timestamps, and a failure reason if applicable.\n\nOnly segments created via the Public API can be queried using this endpoint.\n\nScopes Required: [segments:Read]\n\nDefault Rate Limit: 100 requests per second\n",
        "operationId": "getClearSegmentStatus",
        "tags": [
          "Segments"
        ],
        "parameters": [
          {
            "name": "externalId",
            "in": "path",
            "description": "External ID of the segment to check clear status for",
            "required": true,
            "schema": {
              "type": "string",
              "minLength": 1,
              "maxLength": 255
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Clear segment status retrieved successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClearSegmentStatusResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request - segment is not a Public API segment"
          },
          "401": {
            "description": "Unauthorized - invalid or missing token"
          },
          "403": {
            "description": "Access denied - insufficient permissions"
          },
          "404": {
            "description": "Segment not found or no clear operation has been performed"
          },
          "429": {
            "description": "Too many requests - rate limit exceeded"
          },
          "500": {
            "description": "Internal server error"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT"
      },
      "OAuthFlow": {
        "type": "oauth2",
        "description": "This API uses OAuth 2 with the authorization code grant flow. [More info](https://docs.attentivemobile.com/pages/authentication/)",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://ui-devel.attentivemobile.com/integrations/oauth-install?client_id={clientId}&redirect_uri={redirectUri}&scope={scope}",
            "tokenUrl": "https://api.attentivemobile.com/v1/authorization-codes/tokens",
            "scopes": {
              "attributes:write": "read and write custom attributes",
              "subscriptions:write": "read and write subscriptions",
              "events:write": "read and write custom events",
              "ecommerce:write": "read and write ecommerce events",
              "segments:write": "read and write segments",
              "segments:read": "read segments",
              "content:write": "read and write content"
            }
          }
        }
      }
    },
    "schemas": {
      "ClearSegmentStatusResponse": {
        "type": "object",
        "properties": {
          "status": {
            "type": "string",
            "enum": [
              "RUNNING",
              "COMPLETED",
              "FAILED",
              "NOT_FOUND"
            ],
            "description": "The status of the most recent clear-segment operation. `RUNNING` indicates the operation is still in progress. `COMPLETED` indicates the operation finished successfully. `FAILED` indicates the operation encountered an error. `NOT_FOUND` indicates no clear operation has been performed for this segment.\n",
            "example": "COMPLETED"
          },
          "startedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when the clear operation started processing",
            "example": "2026-09-22T14:30:00Z"
          },
          "completedAt": {
            "type": "string",
            "format": "date-time",
            "description": "The timestamp when the clear operation finished. Only present when status is COMPLETED or FAILED.",
            "example": "2026-09-22T14:31:00Z"
          },
          "failureReason": {
            "type": "string",
            "description": "A description of why the clear operation failed. Only present when status is FAILED.",
            "example": "The clear operation failed"
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false
  }
}
```