Sign in

v1

latestOpenAPI 3.0.12026-07-1481717.4 KB
Interests

Return a list of interests that have been published on a register.

get/api/v1/Interests

Query parameters

MemberIdinteger

Search for an interest created by member with this ID.

CategoryIdinteger

Search for an interest within a specific category with this ID.

PublishedFromstring date

Search for an interest published on or after this date.

PublishedTostring date

Search for an interest published on or before this date.

RegisteredFromstring date

Search for an interest registered on or after this date.

RegisteredTostring date

Search for an interest registered on or before this date.

UpdatedFromstring date

Search for an interest which has any updates on or after this date.

UpdatedTostring date

Search for an interest which has any updates on or before this date.

RegisterIdinteger

Search for an interest published in a register with this ID. If not provided, default value is latest register ID.

ExpandChildInterestsboolean

If true returns related interests in a nested format, rather than as individual items.

Takeinteger

The number of records to return, default is 20. Maximum is 20.

SortOrder'PublishingDateDescending' | 'CategoryAscending'

The order in which interests endpoints should return results.

The order in which to return records.

Skipinteger

The number of records to skip from the first, default is 0.

Response

OK

skipinteger

The skip value that was used in the query.

takeinteger

The take value that was used in the query.

totalResultsinteger

The total number of results which matches the query.