HomeAPI Reference
API Reference

Retrieves hierarchy relations with filtering, sorting, and pagination options. Returns list of hierarchy relationships or paginated results

get
https://api.recvue.com/api/v2.0/parties/relations

Fetches party hierarchy relations with support for search, field selection, sorting, and pagination. All parameters are optional. Returns up to 10 records by default. Specify 'limit' to change the maximum, or use 'page' and 'size' to paginate through results.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int32
Defaults to 10

Maximum number of records to return when pagination is not used (i.e., when both 'page' and 'size' are not provided).

string

Search keyword to filter hierarchy relation records. Searches across multiple fields including hierarchy name.

fields
array of strings

Select specific fields to include in response (e.g., hierarchyName, parentPartyId). Reduces payload size and improves performance.

fields
int32
Defaults to 10

Number of records per page. Controls pagination size. Use with 'page' parameter.

int32
Defaults to 1

Page number to retrieve (starts from 1). Use with 'size' parameter for pagination.

sort
array of strings
Defaults to hierarchyName:ASC

Field(s) to sort by. Format: fieldName:ASC or fieldName:DESC. Supports multiple fields using comma-separated values: sort=field1:ASC,field2:DESC

sort
Headers
string
required
Responses

Updated 3 months ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago