API ReferenceOnboarding

Get All Onboardings

  1. Get Partner from request
  2. Get Partner Onboardings and filter (pcid or external id) if needed
  3. Return a list of onboardings with their id and consumer data

Headers

AuthorizationstringRequired

Basic authentication of the form Basic <username:password>.

Query parameters

pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
searchstringOptional
A search term.
consumer_idstringRequired
Consumer ID
consumer_pcidstringRequired
Consumer PCID

Response

countinteger
resultslist of objects
nextstring or nullformat: "uri"
previousstring or nullformat: "uri"