devices

Query

Search for devices based on a set of filters.

Response

Returns DeviceConnection

Arguments

Name	Type	Description
`filter`	`FilterDeviceInput`	Filter devices by id, uuid and/or name.
`first`	`Int!`	Returns the first n elements from the list. Default: `20`
`after`	`String`	Returns the elements in the list that come after the specified cursor.
`sort`	`[DevicesSort!]!`	The field and direction by which to sort the results Default: `[{ field: NAME, direction: ASC }, { field: ID, direction: ASC }]`

Example

query devices(
  $filter: FilterDeviceInput,
  $first: Int!,
  $after: String,
  $sort: [DevicesSort!]!
) {
  devices(
    filter: $filter,
    first: $first,
    after: $after,
    sort: $sort
  ) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node {
        id
        uuid
        externalId
        name
        enabled
        address
        frameRate
        transcoderId
        lastHeartbeat
      }
      cursor
    }
    totalCount
  }
}

{
  "first": 20,
  "sort": [
    {
      "field": "NAME",
      "direction": "ASC"
    },
    {
      "field": "ID",
      "direction": "ASC"
    }
  ]
}

{
  "data": {
    "devices": {
      "pageInfo": {
        "hasNextPage": false,
        "hasPreviousPage": true,
        "startCursor": "startCursor-867d",
        "endCursor": "endCursor-f100"
      },
      "edges": [
        {
          "node": {
            "id": "61d2e4db-361d-8d20-92f2-04f4efd74ac2",
            "uuid": "c43d07da-1005-849e-88e2-1ac21370e6c3",
            "externalId": "fb6f96a9-958e-889f-8d8b-56797ec9a35c",
            "name": "name-c8f9",
            "enabled": true,
            "address": "address-b541",
            "frameRate": 198.29,
            "transcoderId": "26ca1b82-27b2-8a32-9063-ce85dbc5be74",
            "lastHeartbeat": "2025-01-01T00:00:00.000Z"
          },
          "cursor": "cursor-fc73"
        }
      ],
      "totalCount": 392
    }
  }
}