Skip to content
Vouch Docs

List Pairs

GET
/admin/pairs
curl --request GET \
  --url 'https://example.com/admin/pairs?limit=100&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
state
Any of:
PairState
string
Allowed values: awaiting_both awaiting_one compared
limit
Limit
integer
default: 100 >= 1 <= 500
offset
Offset
integer
0

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response List Pairs Admin Pairs Get
Array<object>
AdminPairOut
object
created_at
required
Created At
string format: date-time
id
required
Id
string format: uuid
match
required
Any of:
AdminMatchOut
object
created_at
required
Created At
string format: date-time
mutual_count
required
Mutual Count
integer
state
required
State
string
updated_at
required
Updated At
string format: date-time
username_hi
required
Any of:
string
username_lo
required
Any of:
string
Examplegenerated
[
  {
    "created_at": "2026-04-15T12:00:00Z",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "match": {
      "created_at": "2026-04-15T12:00:00Z",
      "mutual_count": 1
    },
    "state": "example",
    "updated_at": "2026-04-15T12:00:00Z",
    "username_hi": "example",
    "username_lo": "example"
  }
]

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}