Skip to main content
GET
/
v1
/
dict
/
vsync
List All VSync States
curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/vsync \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "createdAt": "2024-01-15T10:30:00Z",
      "id": "0192c3a4-5b6d-7e8f-9a0b-1c2d3e4f5a6b",
      "keyType": "CPF",
      "lastCidCreatedAt": "2024-01-15T10:30:00Z",
      "lastFullReconciliation": "2024-01-15T10:30:00Z",
      "lastSyncCheck": "2024-01-15T10:30:00Z",
      "lastSyncStatus": "SYNCED",
      "lastSyncTimestamp": "2024-01-15T10:30:00Z",
      "localVSync": "0000000000000000000000000000000000000000000000000000000000000000",
      "updatedAt": "2024-01-15T10:30:00Z"
    }
  ],
  "limit": 10,
  "page": 1,
  "total": 5
}

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