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

# List Reclamation Candidates

> List a team's reclamation-candidate reclamations — entitlement grants flagged for review or reclaim because the user stopped signing in. Filter by status, app instance, or a name search. The response also carries the team-wide reclaimed/dismissed tally shown on the roles page.



## OpenAPI

````yaml /sections/api-reference/openapi-spec-v2.yaml get /v2/teams/{team_id}/reclamation-candidates
openapi: 3.1.0
info:
  title: Serval Public API
  description: Serval Public API
  contact:
    name: Serval
    url: https://serval.com
    email: support@serval.com
  license:
    name: Serval License
    url: https://serval.com/license
  version: 2.0.0
servers:
  - url: https://public.api.serval.com
security:
  - BearerAuth: []
tags:
  - name: Access Policy API
  - name: Access Policy Approval Procedure API
  - name: Access Profile API
  - name: Access Relationship API
  - name: Access Request API
  - name: Agent API
  - name: App Instance API
  - name: App Resource API
  - name: App Resource Role API
  - name: Approval Delegation API
  - name: Approval Request API
  - name: Assignment Rules API
  - name: Audit Log API
  - name: Change Blackout API
  - name: Change Model API
  - name: Custom Field API
  - name: Custom Service API
  - name: Entity API
  - name: Entity Field Mapping API
  - name: Entity Ingestion Config API
  - name: Entity Type API
  - name: Folder API
  - name: Forms API
  - name: Group API
  - name: Guidance API
  - name: Help Agent API
  - name: Journey API
  - name: Knowledge API
  - name: Knowledge Base API
  - name: Report API
  - name: Roles API
  - name: SLA API
  - name: Schedule API
  - name: Tag API
  - name: Team API
  - name: Team Group API
  - name: Team User API
  - name: Ticket API
  - name: Topic API
  - name: User API
  - name: User Relationship API
  - name: Workflow API
  - name: Workflow Approval Procedure API
  - name: Workflow Run API
paths:
  /v2/teams/{team_id}/reclamation-candidates:
    get:
      tags:
        - Roles API
      summary: List Reclamation Candidates
      description: >-
        List a team's reclamation-candidate reclamations — entitlement grants
        flagged for review or reclaim because the user stopped signing in.
        Filter by status, app instance, or a name search. The response also
        carries the team-wide reclaimed/dismissed tally shown on the roles page.
      operationId: svrelay.publicv2.PublicAPIServiceV2.ListReclamationCandidates
      parameters:
        - name: team_id
          in: path
          required: true
          schema:
            type: string
            title: team_id
        - name: status
          in: query
          schema:
            oneOf:
              - $ref: >-
                  #/components/schemas/svhelp.pubapimodels.ReclamationCandidateStatus
              - type: 'null'
            title: status
            description: Only return reclamations in this state. Unset returns every state.
        - name: appInstanceIds
          in: query
          schema:
            type: array
            items:
              type: string
            title: app_instance_ids
            description: >-
              Scope to these app instances (integrations). Empty selects every
              one.
        - name: search
          in: query
          schema:
            type: string
            title: search
            description: >-
              Case-insensitive substring match on the entitlement or resource
              name.
        - name: pageSize
          in: query
          schema:
            type: integer
            title: page_size
            format: int32
        - name: pageToken
          in: query
          schema:
            type: string
            title: page_token
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/svhelp.publicapi.ListReclamationCandidatesResponse
      security:
        - BearerAuth: []
components:
  schemas:
    svhelp.pubapimodels.ReclamationCandidateStatus:
      type: string
      title: ReclamationCandidateStatus
      enum:
        - RECLAMATION_CANDIDATE_STATUS_UNSPECIFIED
        - RECLAMATION_CANDIDATE_STATUS_IN_REVIEW
        - RECLAMATION_CANDIDATE_STATUS_RECLAIMING
        - RECLAMATION_CANDIDATE_STATUS_REVIEW_DISMISSED
        - RECLAMATION_CANDIDATE_STATUS_REVIEW_RECLAIMED
        - RECLAMATION_CANDIDATE_STATUS_AUTO_RECLAIMED
        - RECLAMATION_CANDIDATE_STATUS_RECLAIM_FAILED
      description: >-
        The lifecycle state of an reclamation-candidate reclamation, derived
        server-side.
    svhelp.publicapi.ListReclamationCandidatesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/svhelp.pubapimodels.ReclamationCandidate'
          title: data
          x-stainless-terraform-configurability: optional
        nextPageToken:
          type:
            - string
            - 'null'
          title: next_page_token
          description: Cursor for the next page; empty when there are no more results.
          x-stainless-terraform-configurability: optional
        stats:
          $ref: '#/components/schemas/svhelp.publicapi.ReclamationCandidateStats'
          title: stats
          description: >-
            Team-wide concluded dismiss/reclaim tally, independent of the
            filters above.
             Backs the /roles stat widgets.
          x-stainless-terraform-configurability: optional
      title: ListReclamationCandidatesResponse
      additionalProperties: false
    svhelp.pubapimodels.ReclamationCandidate:
      type: object
      properties:
        id:
          type: string
          title: id
          description: The ID of the reclamation-candidate reclamation.
          readOnly: true
          x-stainless-terraform-configurability: computed
        teamId:
          type: string
          title: team_id
          description: The ID of the team the flagged grant belongs to.
          x-stainless-terraform-configurability: optional
        entitlementId:
          type: string
          title: entitlement_id
          description: The ID of the entitlement (the role/group) the grant is on.
          x-stainless-terraform-configurability: optional
        userId:
          type: string
          title: user_id
          description: The ID of the user whose access is flagged.
          x-stainless-terraform-configurability: optional
        appInstanceId:
          type: string
          title: app_instance_id
          description: The ID of the app instance (integration) the entitlement lives on.
          x-stainless-terraform-configurability: optional
        resourceType:
          type: string
          title: resource_type
          description: The entitlement's resource type slug (e.g. "access").
          readOnly: true
          x-stainless-terraform-configurability: computed
        status:
          $ref: '#/components/schemas/svhelp.pubapimodels.ReclamationCandidateStatus'
          title: status
          description: The reclamation's derived lifecycle state.
          readOnly: true
          x-stainless-terraform-configurability: computed
        createdAt:
          $ref: '#/components/schemas/google.protobuf.Timestamp'
          title: created_at
          description: >-
            When the reclamation was raised. RFC 3339 (e.g.
            "2017-01-15T01:30:15.01Z").
          readOnly: true
          x-stainless-terraform-configurability: computed
        concludedAt:
          oneOf:
            - $ref: '#/components/schemas/google.protobuf.Timestamp'
            - type: 'null'
          title: concluded_at
          description: >-
            When the reclamation concluded (dismissed, reclaimed, or
            reclaim-failed).
             Absent while in review or reclaiming.
          readOnly: true
          x-stainless-terraform-configurability: computed
        lastLoginAt:
          oneOf:
            - $ref: '#/components/schemas/google.protobuf.Timestamp'
            - type: 'null'
          title: last_login_at
          description: >-
            The user's last login on this app instance, the inactivity signal
            that
             flagged the grant. Absent if no login is on record.
          readOnly: true
          x-stainless-terraform-configurability: computed
        decidedByUserId:
          type:
            - string
            - 'null'
          title: decided_by_user_id
          description: >-
            The reviewer who concluded a gated review. Absent for auto-reclaims
            and
             rows still in review.
          readOnly: true
          x-stainless-terraform-configurability: computed
      title: ReclamationCandidate
      additionalProperties: false
      description: >-
        An reclamation-candidate reclamation: one entitlement grant flagged for
        review or
         reclaim because the user stopped signing in. References are bare IDs; resolve
         entitlement, app instance and user via their own endpoints.
    svhelp.publicapi.ReclamationCandidateStats:
      type: object
      properties:
        reclaimed:
          type: integer
          title: reclaimed
          format: int32
          description: >-
            Reclamation candidates whose review concluded with the grant
            reclaimed.
          x-stainless-terraform-configurability: optional
        dismissed:
          type: integer
          title: dismissed
          format: int32
          description: >-
            Reclamation candidates whose review concluded with the grant
            dismissed.
          x-stainless-terraform-configurability: optional
      title: ReclamationCandidateStats
      additionalProperties: false
      description: >-
        ReclamationCandidateStats is a team's concluded reclamation-candidate
        tally. Only concluded
         dismiss/reclaim rows are counted; 'reclaim-failed' and still-in-review rows are
         excluded from both fields. int32 (like SlaStatistics) so proto-JSON
         serializes plain numbers the analytics workflow consumes without int64
         string decoding.
    google.protobuf.Timestamp:
      type: string
      examples:
        - '2025-01-15T01:30:15.000Z'
        - '2025-06-01T00:00:00.000Z'
      format: date-time
      description: A timestamp in RFC 3339 format (e.g., "2025-01-15T01:30:15Z").
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````