> ## Documentation Index > Fetch the complete documentation index at: https://docs.flextell.ai/llms.txt > Use this file to discover all available pages before exploring further. # Get data erasure requests ## OpenAPI ````yaml /api-referansi/openapi.json get /v1/data-erasure-requests openapi: 3.1.0 info: title: Flextell API version: 0.0.1 description: >- Flextell REST API referansı. Kimlik doğrulama, scope ve istek kuralları için API sekmesindeki rehberlere bakın. servers: - url: https://app.flextell.ai/api description: Üretim security: - oauth2: [] - bearer: [] paths: /v1/data-erasure-requests: get: tags: - DataErasureRequest summary: Get data erasure requests operationId: dataErasureRequest.index parameters: - name: status in: query description: Filter by erasure request status. schema: anyOf: - $ref: '#/components/schemas/ErasureRequestStatus' - type: 'null' - name: created_at_from in: query description: Filter records created on or after this date. schema: type: - string - 'null' format: date-time - name: created_at_to in: query description: Filter records created on or before this date. schema: type: - string - 'null' format: date-time - name: per_page in: query description: The number of items per page. schema: type: - integer - 'null' minimum: 1 maximum: 100 - name: page in: query description: The page number. schema: type: - integer - 'null' minimum: 1 - name: sort_by in: query description: The field to sort by. schema: type: - string - 'null' enum: - created_at - verified_at - executed_at - status - null - name: sort_order in: query description: The sort direction (asc or desc). schema: type: - string - 'null' enum: - asc - desc - null - name: X-Tenant in: header required: true description: >- Tenant identifier. Send the Tenant ID in the `X-Tenant` header to scope API requests to a specific tenant. schema: type: number responses: '200': description: Paginated set of `DataErasureRequestResource` content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/DataErasureRequestResource' links: type: object properties: first: type: - string - 'null' last: type: - string - 'null' prev: type: - string - 'null' next: type: - string - 'null' required: - first - last - prev - next meta: type: object properties: current_page: type: integer minimum: 1 from: type: - integer - 'null' minimum: 1 last_page: type: integer minimum: 1 links: type: array description: Generated paginator links. items: type: object properties: url: type: - string - 'null' label: type: string active: type: boolean required: - url - label - active path: type: - string - 'null' description: Base path for paginator generated URLs. per_page: type: integer description: Number of items shown per page. minimum: 0 to: type: - integer - 'null' description: Number of the last item in the slice. minimum: 1 total: type: integer description: Total number of items being paginated. minimum: 0 required: - current_page - from - last_page - links - path - per_page - to - total required: - data - links - meta '401': $ref: '#/components/responses/AuthenticationException' '403': $ref: '#/components/responses/AuthorizationException' '422': $ref: '#/components/responses/ValidationException' '428': description: >- Mandatory setup is incomplete. Finish the setup wizard first; `data.next_step` names the step to continue with. content: application/json: schema: type: object properties: success: type: boolean examples: - false error_code: type: string enum: - SETUP_REQUIRED examples: - SETUP_REQUIRED message: type: string examples: - Complete the required setup steps to continue. data: type: object properties: next_step: type: - string - 'null' examples: - clinic_info required: - next_step required: - success - error_code - message - data components: schemas: ErasureRequestStatus: type: string description: > Where a patient's erasure request has got to. The happy path is PendingVerification → Verified → Processing → Completed. The side exits are all terminal: a link that ran out of time, a request the clinic withdrew, or a run that failed part way and needs a person to look at it before it is tried again. enum: - pending_verification - verified - processing - completed - expired - cancelled - failed title: ErasureRequestStatus DataErasureRequestResource: type: object properties: id: type: integer tenant_id: type: integer customer_id: type: - integer - 'null' customer: $ref: '#/components/schemas/RelatedCustomerResource' requested_by: $ref: '#/components/schemas/RelatedUserResource' cancelled_by: $ref: '#/components/schemas/RelatedUserResource' status: type: string request_reason: type: - string - 'null' scope_summary: type: array items: {} verification_channel: type: - string - 'null' verification_expires_at: type: - string - 'null' format: date-time resend_count: type: integer last_sent_at: type: - string - 'null' format: date-time verified_at: type: - string - 'null' format: date-time executed_at: type: - string - 'null' format: date-time execution_report: type: - array - 'null' items: {} certificate_code: type: - string - 'null' cancelled_at: type: - string - 'null' format: date-time cancellation_reason: type: - string - 'null' state_allows: type: object properties: resend: type: boolean cancel: type: boolean retry: type: boolean certificate: type: boolean required: - resend - cancel - retry - certificate created_at: type: - string - 'null' format: date-time updated_at: type: - string - 'null' format: date-time required: - id - tenant_id - customer_id - status - request_reason - scope_summary - verification_channel - verification_expires_at - resend_count - last_sent_at - verified_at - executed_at - execution_report - certificate_code - cancelled_at - cancellation_reason - state_allows - created_at - updated_at title: DataErasureRequestResource RelatedCustomerResource: type: object properties: id: type: integer record_state: $ref: '#/components/schemas/RecordStateResource' first_name: anyOf: - type: string - type: 'null' last_name: anyOf: - type: string - type: 'null' phone_number: anyOf: - type: string - type: 'null' email: anyOf: - type: string - type: 'null' is_masked: type: boolean description: >- Whether the identity fields are masked because the viewer may not see this lead's patient. is_lead_stage: type: boolean description: >- Whether the person is still a lead (link to `/leads/{lead_id}`) rather than a patient (link to `/customers/{id}`). lead_id: type: - integer - 'null' description: >- The lead the person came from; kept after conversion, so check `is_lead_stage` before linking to it. required: - id - record_state - first_name - last_name - phone_number - email - is_masked - is_lead_stage - lead_id title: RelatedCustomerResource RelatedUserResource: type: object properties: id: type: integer name: type: string avatar_url: type: - string - 'null' description: >- A signed profile photo URL valid for a few hours, or `null` without a photo. Only on responses that opt in. required: - id - name title: RelatedUserResource RecordStateResource: type: object properties: is_read_only: type: boolean description: >- True when every write on this record is refused; false does not imply the caller may write. reason_code: type: - string - 'null' description: >- Why the record is read-only (`CUSTOMER_ERASED`, or `LEAD_NOT_ASSIGNED` for a salesperson on another rep's lead), or null when it is not. required: - is_read_only - reason_code title: RecordStateResource responses: AuthenticationException: description: Unauthenticated content: application/json: schema: type: object properties: message: type: string description: Error overview. required: - message AuthorizationException: description: Authorization error content: application/json: schema: type: object properties: message: type: string description: Error overview. required: - message ValidationException: description: Validation error content: application/json: schema: type: object properties: message: type: string description: Errors overview. errors: type: object description: A detailed description of each field that failed validation. additionalProperties: type: array items: type: string required: - message - errors securitySchemes: oauth2: type: oauth2 flows: authorizationCode: authorizationUrl: https://dev.flextell.ai/oauth/authorize tokenUrl: https://dev.flextell.ai/oauth/token scopes: '*': all bearer: type: http scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.