List sweeps - Switchyard Documentation

List sweeps

curl --request GET \
  --url http://localhost:3000/v1/scanner/sweeps

{
  "sweeps": [
    null
  ],
  "total": 123,
  "message": "<string>"
}

GET

scanner

sweeps

List sweeps

curl --request GET \
  --url http://localhost:3000/v1/scanner/sweeps

{
  "sweeps": [
    null
  ],
  "total": 123,
  "message": "<string>"
}

filter

enum<string>

default:my

Filter sweeps by status

Available options:

my,

available,

completed,

all,

ready_to_receive,

receiving_upcoming,

received

Example:

"my"

limit

integer

default:20

Maximum number of results

Required range: 1 <= x <= 100

Example:

20

offset

integer | null

default:0

Offset for pagination

Required range: x >= 0

Example:

0

200 - application/json

List of sweeps

sweeps

null[]

required

total

number

required

message

string