Skip to main content
GET
List All VSync States

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

page
integer<int64>
default:1

Page number for pagination (default: 1, minimum: 1)

limit
integer<int64>
default:5

Maximum number of items per page (default: 5, range: 1-100)

key_type
string

Filter by key type: CPF, CNPJ, EMAIL, PHONE, EVP

status
string[]

Filter by sync status (comma-separated, OR-matched): SYNCED, OUT_OF_SYNC, RECONCILING, ERROR

sort_order
string

Sort direction: asc or desc (default: asc)

Response

OK

items
object[]
required

Array of VSync states for the current page

limit
integer<int64>
required

Number of items per page

Example:

10

page
integer<int64>
required

Current page number

Example:

1

total
integer<int64>
required

Total number of VSync states matching the filters

Example:

5