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

# Get endpoint by ID

> Retrieves detailed information about a specific endpoint including its public IPs and integration data



## OpenAPI

````yaml https://api.wirespeed.co/v1/openapi.json get /v1/endpoint/{id}
openapi: 3.0.0
info:
  title: Wirespeed API
  description: The public Wirespeed API. v1 is the first stable contract.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wirespeed.co
security: []
tags: []
paths:
  /v1/endpoint/{id}:
    get:
      tags:
        - Endpoint
      summary: Get endpoint by ID
      description: >-
        Retrieves detailed information about a specific endpoint including its
        public IPs and integration data
      operationId: EndpointController_getById
      parameters:
        - name: id
          required: true
          in: path
          description: Unique identifier of the endpoint (UUID)
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpError'
      security:
        - bearer: []
components:
  schemas:
    Endpoint:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the endpoint
        displayName:
          type: string
          description: Human-readable display name for the endpoint
        teamId:
          type: string
          description: ID of the team that owns this endpoint
        edrSourceId:
          type: string
          description: ID from the EDR (Endpoint Detection & Response) system
        mdmSourceId:
          type: string
          description: ID from the MDM (Mobile Device Management) system
        name:
          type: string
          description: Name of the endpoint
        hva:
          type: boolean
          description: Indicates if this is a Critical Asset
        hvaOverriddenByUser:
          type: boolean
          description: >-
            Indicates if the Critical Asset status was manually overridden by a
            user
        createdAt:
          type: string
          description: Timestamp when the endpoint was created
        privateIpAddress:
          type: string
          description: Private IP address of the endpoint
        live:
          type: boolean
          description: Indicates if the endpoint is currently active/online
        operatingSystem:
          type: string
          description: Operating system of the endpoint
        operatingSystemCategory:
          type: string
          enum:
            - Windows
            - Windows Server
            - macOS
            - Linux
            - iOS
            - Android
            - ChromeOS
            - Network Device
            - Other
          description: Categorized operating system type
        integrationId:
          type: string
          nullable: true
          description: ID of the integration that discovered this endpoint
        canonicalId:
          type: string
          nullable: true
          description: >-
            When set, this row is a duplicate source; points at the canonical
            representative endpoint id
        canonicalClusterMemberCount:
          type: number
          nullable: true
          description: >-
            Child endpoint rows in the same canonical cluster (canonical_id =
            root), excluding the root row; null when asset dedupe is off or
            there are no children
        canonicalClusterMembers:
          nullable: true
          description: >-
            Preview of other integration-backed rows in the same canonical
            cluster (at most five children when count exceeds five); null when
            none
          example:
            - id: 22222222-2222-2222-2222-222222222201
              displayLabel: WS-SAMPLE-BRAVO-WKS$
              integrationId: aaaaaaaa-bbbb-cccc-dddd-eeeeeeee0002
              integrationPlatform: sentinel-one
              name: WS-SAMPLE-BRAVO-WKS$
              managed: true
              live: true
              operatingSystem: Windows11 - 23H2
              createdAt: '2025-01-02T00:00:00.000Z'
              updatedAt: '2025-01-15T12:00:00.000Z'
            - id: 22222222-2222-2222-2222-222222222202
              displayLabel: WS-SAMPLE-CHARLIE-WKS$
              integrationId: aaaaaaaa-bbbb-cccc-dddd-eeeeeeee0003
              integrationPlatform: crowdstrike-falcon
              name: WS-SAMPLE-CHARLIE-WKS$
              managed: true
              live: true
              operatingSystem: Windows 10 Enterprise 22H2 (OS build 19045.4046)
              createdAt: '2025-01-03T00:00:00.000Z'
              updatedAt: '2025-01-15T12:00:00.000Z'
          type: array
          items:
            $ref: '#/components/schemas/CanonicalAssetClusterMemberDto'
        contained:
          type: boolean
          description: Indicates if the endpoint has been contained/isolated
        managed:
          type: boolean
          description: Indicates if the endpoint is managed by MDM/EDR
        publicIpAddress:
          type: string
          description: Public IP address associated with this endpoint
        workstation:
          type: boolean
          description: Indicates if this is a workstation device
        server:
          type: boolean
          description: Indicates if this is a server device
        mobile:
          type: boolean
          description: Indicates if this is a mobile device
        domainController:
          type: boolean
          description: Indicates if this is a domain controller
        lastSeenAt:
          type: string
          description: Timestamp when the endpoint was last seen
        updatedAt:
          type: string
          description: Timestamp when the endpoint was last updated
        raw:
          type: object
          description: Raw data from the integration source
        groups:
          description: Groups assigned to this endpoint
          type: array
          items:
            $ref: '#/components/schemas/EndpointGroupDTO'
        groupContainmentEnabled:
          type: boolean
          description: Whether all groups on this endpoint allow containment
        groupChatOpsEnabled:
          type: boolean
          description: Whether all groups on this endpoint allow chat ops
        groupSourceSystemUpdates:
          type: boolean
          description: >-
            Whether all groups on this endpoint allow outbound updates to the
            source product
        groupsSynced:
          type: boolean
          description: Whether this endpoint has had its first round of group checks run
        lockPin:
          type: string
          nullable: true
          description: >-
            Lock PIN for this device, set when the device was locked via MDM
            (e.g. JumpCloud Apple MDM). Null if not locked or PIN not available.
      required:
        - id
        - displayName
        - teamId
        - hva
        - createdAt
        - integrationId
        - contained
        - workstation
        - server
        - mobile
        - domainController
        - groups
        - groupContainmentEnabled
        - groupChatOpsEnabled
        - groupSourceSystemUpdates
        - groupsSynced
    HttpError:
      type: object
      properties:
        message:
          type: string
        statusCode:
          type: number
      required:
        - message
        - statusCode
    CanonicalAssetClusterMemberDto:
      type: object
      properties:
        id:
          type: string
          description: Directory user or endpoint id
        displayLabel:
          type: string
          description: Display label for the row
        integrationId:
          type: string
          nullable: true
          description: Integration id for this source row
        integrationPlatform:
          type: string
          enum:
            - admin-by-request
            - aws
            - axonius
            - bitwarden
            - box
            - checkpoint-firewall
            - checkpoint-harmony
            - cisco-catalyst
            - cisco-duo
            - cisco-meraki
            - cisco-secure-access
            - cisco-umbrella
            - cisco-xdr
            - connectwise-psa
            - crowdstrike-falcon
            - cyberark
            - darktrace
            - email
            - exium
            - fleet-dm
            - fortianalyzer
            - fortinet
            - freshservice
            - generic-json
            - generic-syslog
            - google-alert-center
            - google-chronicle
            - google-directory
            - google-security-center
            - halcyon
            - halo-itsm
            - have-i-been-pwned
            - horizon3
            - hyas-protect
            - ipinfo
            - jamf-pro
            - jamf-protect
            - jira-cloud
            - jira-data-center
            - jumpcloud
            - kandji
            - manage-engine-ad-audit-plus
            - microsoft
            - microsoft-entra
            - microsoft-teams
            - microsoft-teams-v2
            - mimecast
            - ninjaone
            - odoo-helpdesk
            - okta
            - one-password
            - onelogin
            - orca-security
            - pager-duty
            - palo-alto-networks-cortex
            - picus
            - ping-one
            - reversing-labs
            - safebreach
            - sandfly
            - sentinel-one
            - service-now
            - slack
            - sms
            - smtp
            - sonic-wall
            - sophos
            - splunk
            - stairwell
            - tenable-nessus
            - thinkst-canary
            - tracebit
            - unifi
            - vectra
            - watchguard-firebox
            - windows-event-logs
            - wirespeed
            - wiz
            - wordfence
            - zscaler-zpa
          nullable: true
          description: Integration platform when joined from integration table
        name:
          type: string
          nullable: true
        username:
          type: string
          nullable: true
        email:
          type: string
          nullable: true
        additionalEmails:
          nullable: true
          type: array
          items:
            type: string
        roles:
          nullable: true
          type: array
          items:
            type: string
        title:
          type: string
          nullable: true
        department:
          type: string
          nullable: true
        managed:
          type: boolean
          nullable: true
        enabled:
          type: boolean
          nullable: true
        createdAt:
          type: string
          nullable: true
        updatedAt:
          type: string
          nullable: true
        live:
          type: boolean
          nullable: true
        operatingSystem:
          type: string
          nullable: true
        privateIpAddress:
          type: string
          nullable: true
        publicIpAddress:
          type: string
          nullable: true
      required:
        - id
        - displayLabel
        - integrationId
    EndpointGroupDTO:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the endpoint group
        endpointId:
          type: string
          description: ID of the endpoint this group belongs to
        group:
          type: string
          description: Group type (system enum or custom string)
        teamId:
          type: string
          description: Team ID that owns this group
        enabled:
          type: boolean
          description: Whether the group is currently enabled
        createdAt:
          type: string
          description: Timestamp when the group was created
        overriddenByUser:
          type: boolean
          description: Whether the group was manually overridden by a user
        overriddenByUserId:
          type: string
          description: ID of the user who manually overrode the group
        overriddenByUserIdentifier:
          type: string
          nullable: true
          description: >-
            Email of the user who manually overrode the group (persists after
            user deletion)
        groupId:
          type: string
          description: Group ID from the group table
        groupName:
          type: string
          description: Display name of the associated group
        groupSlug:
          type: string
          description: Slug of the associated group
        groupContainmentEnabled:
          type: boolean
          description: Whether the associated group allows containment
        groupChatOpsEnabled:
          type: boolean
          description: Whether the associated group allows chat ops
        groupSourceSystemUpdates:
          type: boolean
          description: >-
            Whether the associated group allows outbound updates to the source
            product
        groupAlwaysNotify:
          type: boolean
          description: >-
            Whether the associated group always escalates detections to notify
            the client
        groupRuleSearch:
          type: string
          description: >-
            Search expression from the group rule that added this group
            membership
        groupRuleSearchField:
          type: string
          description: Search field from the group rule that added this group membership
        groupRuleSearchType:
          type: string
          enum:
            - text
            - regexp
          description: Search type from the group rule that added this group membership
      required:
        - id
        - endpointId
        - group
        - teamId
        - enabled
        - createdAt
        - overriddenByUser
        - groupId
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http

````