Skip to main content
GET
List All VSync States

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer

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

limit
integer

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: SYNCED, OUT_OF_SYNC, RECONCILING, ERROR

sort_order
string

Sort direction: asc or desc (default: asc)

Response

OK

items
object[]

Items is the array of VSync states for the current page

limit
integer

Limit is the number of items per page

Example:

10

page
integer

Page is the current page number

Example:

1

total
integer

Total is the total number of VSync states matching the filters

Example:

5