🔄Sync Id

Most of the ContentAPI masters contain a large volume of data, which can be challenging to process in a single API request due to its size.

To ensure optimal performance, we limit the data to a maximum of 1000 objects per request, processing the data in batches.

Because of this limitation, you may need to make multiple API requests to the same ContentAPI endpoint to retrieve the complete dataset from a master.

The TCTT API gateway will remember the details of the last ContentAPI request and will automatically process the next batch of data for the client. The SyncId is used to manage this batch operation effectively.

---

How to use SyncId

Every ContentAPI endpoint will return a seperate SyncId as part of the response with each API request.

The client system must retain this SyncId and include it as a query parameter in the next API request to the same API endpoint for retrieving the following batch of data.

Sample Response

{
    "success": true,
    "data": {
        
        "total": 2372,
        "from": 1,
        "to": 1000,
        "countries": [
            {
                "countryId": 111,
                "countryName": "united states",
                "isocode": "US",
                "phonecode": "+1"
            }
        ]
    }
}

No need to pass syncId as query parameter on the first request for a specific ContentAPI endpoint.

Each ContentAPI will have its own separate SyncId.Once the entire dataset from a master has been consumed, the API endpoint will return an empty array.