ScreenMeetTest logoScreenMeetTest documentationAPI referencescreenmeettest
API reference
GET/organization/{id}/supportsessions

List all organization sessions

Returns all support sessions for the organization. Use query parameters to paginate and sort. Use `metaData.client.name` to filter by client type (e.g., `windows-external-unattended` for unattended Windows sessions). See [How to filter unattended sessions](docs/How-to-filter-unattended-sessions.md) for a complete PowerShell example (Tanium, ServiceNow, etc.). **Example: Filtering unattended sessions (PowerShell)** - Useful for Tanium and other customers integrating with unattended access: ```powershell # 1. Headers (uses the $token variable from your login) $headers = @{ Authorization = "Bearer $token" Accept = "application/json" } # 2. Fetch the last 100 sessions to ensure a good sample size $url = "https://api-v3.screenmeet.com/v3/organization/9177/supportsessions?limit=100&orderby=createdAt&orderdir=DESC" $response = Invoke-RestMethod -Uri $url -Method Get -Headers $headers # 3. Filter for the specific 'windows-external-unattended' client name $filteredSessions = $response.rows | Where-Object { $_.metaData.client.name -eq "windows-external-unattended" } # 4. Display the specific matches if ($filteredSessions) { Write-Host "Found $($filteredSessions.Count) Windows Unattended sessions:" -ForegroundColor Green $filteredSessions | Select-Object id, status, @{Name="Version"; Expression={$_.metaData.client.version}}, createdAt | Format-Table } else { Write-Host "No matching client names found in the last 100 sessions." -ForegroundColor Yellow } ```

Authorization

bearerAuth http (bearer)

Parameters

limit (query)

Max sessions to return

string
offset (query)

Row offset for pagination

string
orderby (query)

Field to sort by (e.g., createdAt)

string
orderdir (query)

Sort direction (ASC/DESC)

string
searchterm (query)

Search terms

string
searchfield (query)

Search field

string
id (query)

Filter by session ID

string
status (query)

Filter by status

string
type (query)

Filter by session type

string
ExternalUserId (query)

Filter by external user ID

string
pin (query)

Filter by pin

string
includeCount (query)

Include count in response

string
id (path) Required

Organization ID

string

Responses

200

OK

application/json
object
rowsarray

array
countinteger

integer
parsedParamsobject

Parsed query parameters (optional)

object

Parsed query parameters (optional)

403

Authorization Problem - either the JWT is malformed or the signature is bad, or permission is denied

application/json
object
codenumber

number
refcodenumber

number
descriptionstring

string
X-Request-Idstring

string
{
  "PermissionDenied": {
    "value": {
      "code": 403,
      "refcode": 200403,
      "description": "Authorization token is invalid: Error request id: 1-62ed207a-24baa293558168e06b8402c3 [8/5/2022, 6:51:54 AM PST]",
      "X-Request-Id": "1-62ed207a-24baa293558168e06b8402c3"
    }
  },
  "MalformedJWTOrBadSignature": {
    "value": {
      "code": 403,
      "refcode": 200403,
      "description": "Authorization token is invalid: JsonWebTokenError request id: 1-62ed1a55-0265e424598b4f1b580bd784 [8/5/2022, 6:25:41 AM PST]",
      "X-Request-Id": "1-62ed1a55-0265e424598b4f1b580bd784"
    }
  }
}