Syntax

Get price alerts

GET /v{version}/users/{userId}/pricealerts

Description

This API endpoint enables you to retrieve all price alerts of a specific user.

Parameters

Type
Name
Description
Schema
Default

Header

Authorization required

This is the authorization token that you retrieved from the first endpoint (/token).

string

Path

userId required

This is the internal identifier of the user whose price alerts must be retrieved.

integer (int32)

Path

version required

This is the version of the API. Unless you have multiple versions of AutoShares’s API deployed in your environment, leave it at 1.0.

string

"1"

Query

isDesc required

This is a boolean field that indicates if the returned price alerts should be sorted in descending (true) or ascending (false) order.

boolean

Query

pageNumber required

This is the page number (all price alerts are split into pages).

integer (int32)

Query

pageSize required

This is the number of price alerts that should be retrieved from the specified page.

integer (int32)

Query

sortBy required

Sorting field

string

Responses

HTTP Code
Description
Schema

200

Successful request, JSON data containing the user’s price alerts is returned.

401

The access level of the provided authorization token is not sufficient to perform this operation.

No Content

422

A validation error occurred while processing the request.

No Content

500

Internal server error

No Content

Produces

  • application/json

  • text/json

Last updated