I am creating a custom app in Freshservice to automate the creation of Onboarding Ticket whenever a new employee is hired in my HRMS System.
I have my list of Job titles in a custom objects.
The list is quite big as it consists of 150+ items in it.
I want to get all the custom object records to do a mapping and create the onboarding ticket with proper job title.
The issue that I am facing here is the GET Api for custom object records only return a maximum of 100 records in a single request.
The page query param doesn’t seem to work here.
And When I referred to the API documentations, I came to know that there will be a next_page_link will be sent along with the response which will be further used to get the next page of records.
Could you share the GET API request that has been used, along with the query parameters?
Also, is it possible to share the API response with hidden sensitive information?
Sorry to necro an old thread, but I ran into this. You aren’t supposed to load the next_page_link URL directly, it’s another query string parameter that you call instead. The docs kind of reference this, but it’s confusing until you run into this issue then it makes sense.
If you look at the Link header of the response you get, it actually gives you the full URL to call to get the next page of results (which is a normal thing to do, and some languages like Powershell have parameters so that you don’t have to call the next URL yourself, you can tell it to follow “rel” links which are returned in the Link header of REST calls to indicate the next page of results.
So depending on how or in what language you’re working with, you either need to make sure it will follow “rel” links and it’ll just work, or you need to use the value from the Link header on the response, parse it to get just the value, and then call that instead.
Found this old thread while trying to use pagination in Custom Objects.
I can’t believe this thread is 1,5 years old, and the problem seems still to exist.
I am not a powershell expert, but this is my approach and I think this is how it should work, right? But same issues as all the others: I only get the first page of results, even when utilizing the pagination link in my query. Or did I something wrong here?
$FSAPIKey = "yourFSapiKey"
$apiURL = 'https://yoursubdomain.freshservice.com/api/v2/objects/54000013688/records?page_size=50'
#------------
# Authentication Headers
$EncodedCredentials = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(('{0}:{1}' -f $FSAPIKey, $null)))
$HTTPHeaders = @{}
$HTTPHeaders.Add('Authorization', ('Basic {0}' -f $EncodedCredentials))
#initialize array to store results
$allResults = @()
function Get-AllResults {
# Make the initial API request
Write-Host "First API Request: $apiURL"
$response = Invoke-RestMethod -Uri $apiURL -Headers $HTTPHeaders -ContentType 'applicaton/json' -Method 'Get'
# Add the current batch of results to the array
$allResults += $response.records
Write-Host "All Results: $($allresults.count)"
Write-Host
# Check if there is a next page link
while ($response.next_page_link) {
#URL encode the nextpage link
$nplEncoded = [System.Web.HttpUtility]::UrlEncode($response.next_page_link)
# Update the URL with the next page link
$apiURLnpl = "$($apiURL)&next_page_link=$($nplEncoded)"
# Make the next API request
Write-Host "New Page Link API Request: $apiURLnpl"
$response = Invoke-RestMethod -Uri $apiURLnpl -Headers $HTTPHeaders -ContentType 'applicaton/json' -Method 'Get'
# Add the current batch of results to the array
$allResults += $response.records
Write-Host "All Results: $($allresults.count)"
Write-Host
}
}
Get-AllResults
to encode the string. Turns out this is not sufficient. Instead use this method to encode the string. I corrected my script above, works now like a charm.
