v1

latestOpenAPI 3.0.12026-07-133870165.8 KB
Resources

List Resources

Use this endpoint to return a List of Resources associated with a business location. If not specified, the business location defaults to the primary business location. The results are returned in pages. Use the offset and limit parameters to control the page start and number of results. Default offset is 0, limit is 20, max is 100. Use the query parameters to filter the results further.

get/consumer/v1/resources

Query parameters

locationIdstring

id of business location, defaults to primary business location

resourceGroupIdinteger

Filter by groupId

emailstring

Filter by email address

namestring

Search by name, supports Partial name search

sortOrderstring

Specify sort order of response

offsetinteger

Starting row of page, default 0

limitinteger

Page limit default 20, max 100

Response

resource object

objectstring nullable
urlstring nullable
hasMoreboolean
countinteger
totalinteger