Get Devices

GET

/api/v2/devices

curl --request GET \
  --url 'https://example.com/api/v2/devices?order_by=created_at&order_by_direction=ASC&limit=100&offset=0' \
  --header 'Authorization: Bearer <token>'

Retrieve the list of devices accessible to the authenticated user.

Returns both QPU and emulator devices. Use query parameters to filter by device type, availability, or public visibility. Results include each device’s current status, supported features, and specifications.

Authorizations

• HTTPBearer

Parameters

Query Parameters

order_by

Order By

string

default: created_at

order_by_direction

SortDirection

string

default: DESC

Allowed values: ASC DESC

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

0

device_type

Any of:

Array<string>

Array<string>

Allowed values: EMU_FREE EMU_SV EMU_TN EMU_C FRESNEL FRESNEL_CAN1 FRESNEL_SA1 FRESNEL8 EMU_FRESNEL FRESNEL_RD EMU_MPS

null

null

Filter devices by type. Omit to skip filter.

availability

Any of:

Array<string>

Array<string>

Allowed values: ACTIVE INACTIVE RETIRED

null

null

Filter devices by availability status. Omit to skip filter.

public

Any of:

boolean

boolean

null

null

Filter devices by public visibility. Omit to skip filter.

Responses

200

Successful Response

Media typeapplication/json

HeaderPaginatedResponse[ProducedDeviceResponse]

object

status

JSendStatus

string

default: success

Allowed values: success fail error

message

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

Example

{
  "status": "success",
  "message": "OK.",
  "code": "200"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}