Skip to content

Retrieve all my Watchlists

GET
/api/watchlists

This endpoint allows you to retrieve the list of your Watchlists.

page
integer
default: 1

The collection page number

itemsPerPage
integer
default: 30

The number of items per page

Watchlist collection

object
hydra:member
required
Array<object>
object
@id
string
@type
string
token
string
domains
Array<object>
object
@context
One of:
string
@id
string
@type
string
ldhName
string
handle
string | null
events
array
status
Array<string>
updatedAt
string format: date-time
tld
string format: iri-reference
Example
https://example.com/
deleted
boolean
delegationSigned
boolean
expiresInDays
integer | null
purchaseCount
integer | null
connector
Any of:
object
@context
One of:
string
@id
string
@type
string
id
string | null
provider
string
Allowed values: ovh gandi autodns namecheap namecom epp
createdAt
string format: date-time
name
string | null
createdAt
string format: date-time
dsn
array | null
unique items
trackedEvents
required
Array<string>
unique items
trackedEppStatus
Array<string>
unique items
enabled
boolean
hydra:totalItems
integer
hydra:view
object
@id
string format: iri-reference
@type
string
hydra:first
string format: iri-reference
hydra:last
string format: iri-reference
hydra:previous
string format: iri-reference
hydra:next
string format: iri-reference
Example
{
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
}
hydra:search
object
@type
string
hydra:template
string
hydra:variableRepresentation
string
hydra:mapping
Array<object>
object
@type
string
variable
string
property
string | null
required
boolean