---
title: "GET /api/v1/provider-agents/pending"
method: GET
path: "/api/v1/provider-agents/pending"
tags: ["ProviderAgents"]
---

# GET /api/v1/provider-agents/pending

`GET /api/v1/provider-agents/pending`

## Request

- Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from)
- URL: `https://api.immy.bot/api/v1/provider-agents/pending`
- Auth: none declared

## Query parameters

- `filter` string
- `sort` string
- `take` integer
- `skip` integer
- `sortDesc` boolean
- `includeOffline` boolean
- `tenantId` integer
- `providerLinkId` integer
- `agentFilter` 'All' | 'OnlyPendingIdentification' | 'OnlyIdentified' | 'RequiresManualDecision' | 'AssociatedToDeletedComputers': The string or integer value may be used. All = 1, OnlyPendingIdentification = 2, OnlyIdentified = 3, RequiresManualDecision = 4, AssociatedToDeletedComputers = 5

## Response `200`

OK

- GetPendingResponse
  - `count` integer
  - `results` GetPendingAgentResponse[], nullable
    - `id` integer
    - `computerId` integer, nullable
    - `providerLinkId` integer
    - `computerName` string, nullable
    - `isComputerDeleted` boolean
    - `manufacturer` string, nullable
    - `operatingSystemName` string, nullable
    - `externalAgentId` string, nullable, required
    - `dateAdded` string, date-time
    - `isOnline` boolean
    - `serial` string, nullable
    - `providerLinkName` string, nullable, required
    - `externalClientName` string, nullable
    - `osInstallDateUtc` string, date-time, nullable
    - `requiresManualResolution` boolean
    - `failed` boolean
    - `identificationFailures` GetAgentIdentificationFailureResponse[], nullable
      - `id` integer
      - `computerId` integer, nullable
      - `existingAgentId` integer, nullable
      - `pendingAgentId` integer, nullable
      - `message` string, nullable
      - `createdDateUTC` string, date-time
      - `resolved` boolean
      - `requiresManualResolution` boolean
      - `featureUsageExceeded` boolean
      - `manualResolutionDecision` 'DeleteExisting' | 'GenerateNewDeviceId' | 'OverwriteExisting': The string or integer value may be used. DeleteExisting = 0, GenerateNewDeviceId = 1, OverwriteExisting = 2
      - `existingComputerName` string, nullable
      - `existingPrimaryUserFirstName` string, nullable
      - `existingPrimaryUserLastName` string, nullable
      - `existingTenantName` string, nullable
      - `existingOperatingSystem` string, nullable
      - `existingSerialNumber` string, nullable
      - `existingManufacturer` string, nullable
      - `existingOSInstallDate` string, date-time, nullable
      - `existingAgent` IProviderAgentDetails
        - `agentVersion` SemanticVersion
          - `major` integer
          - `minor` integer
          - `patch` integer
          - `releaseLabels` string[], nullable
          - `release` string, nullable
          - `isPrerelease` boolean
          - `hasMetadata` boolean
          - `metadata` string, nullable
        - `externalClientId` string, nullable
        - `externalAgentId` ExternalAgentId
          - `value` string, nullable
        - `internalData` unknown
        - `isOnline` boolean
        - `lastUpdatedUTC` string, date-time
        - `supportsRunningScripts` boolean
        - `deviceDetails` DeviceDetails
          - `operatingSystemName` string, nullable
          - `manufacturer` string, nullable
          - `deviceName` string, nullable
          - `serialNumber` string, nullable
          - `deviceId` string, uuid, nullable
          - `osInstallDateUTC` string, date-time, nullable
          - `machineId` string, nullable
          - `isSandbox` boolean
          - `domain` string, nullable
          - `azureTenantId` string, nullable
          - `domainRole` integer, nullable
          - `chassisTypes` integer[], nullable
        - `onboardingOptions` AgentOnboardingOptions
          - `automaticallyOnboard` boolean
          - `onboardingCorrelationId` string, nullable
          - `onboardingSessionRebootPreference` 'Normal' | 'Suppress' | 'Prompt' | 'Force': The string or integer value may be used. Normal = 0, Suppress = 1, Prompt = 2, Force = -1
          - `onboardingSessionPromptTimeoutAction` 'Reboot' | 'Suppress' | 'FailSession': The string or integer value may be used. Reboot = 0, Suppress = 1, FailSession = 2
          - `onboardingSessionAutoConsentToReboots` boolean
          - `onboardingSessionPromptTimeoutMinutes` integer
          - `onboardingSessionSendFollowUpEmail` boolean
          - `primaryPersonId` integer, nullable
          - `additionalPersonIds` integer[], nullable
          - `tags` integer[], nullable
          - `isDevLab` boolean
        - `requireManualIdentification` boolean
    - `requireManualIdentification` boolean

---

[API](https://skmtc.dev/immy/apis/immy-bot-api.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api/revisions/559d0e4b39d3?raw)