Honeycluster Docs – Get a watchlist by slug

accounts

Get a watchlist by slug

get

/watchlists/{slug}

operationId: account-getWatchlist

Returns a watchlist with its current membership — the set of addresses assigned to the list plus per-member notes.

Authorizations

Name	Location	Details
`BearerAuth`	Authorization header · bearer	JWT issued by the Honeycluster auth service for the `indexer` audience. Present as `Authorization: Bearer <token>`.

Path Parameters

Name	Type	Default	Description
`slug` required	string		Watchlist slug.

Responses

200

application/json

Successful response

Field	Type	Description
`watchlist`	object
`members`	object[]
`members[].watchlistId`	string	Parent watchlist id (PK part).
`members[].address`	string	XRPL address in the watchlist (PK part).
`members[].note`	object
`members[].addedAt`	integer	Record creation timestamp, Unix-seconds.

Example

Json

{
  "watchlist": {
    "id": "00000000-0000-0000-0000-000000000000",
    "slug": "string",
    "name": "string",
    "description": "string",
    "ownerId": "string",
    "isPublic": false,
    "createdAt": 1745798400,
    "updatedAt": 1745798400
  },
  "members": [
    {
      "watchlistId": "00000000-0000-0000-0000-000000000000",
      "address": "string",
      "note": "string",
      "addedAt": 1745798400
    }
  ]
}

400

application/json

Invalid input data

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401

application/json

Authorization not provided

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403

application/json

Insufficient access

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404

application/json

Not found

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500

application/json

Internal server error

Field	Type	Description
`message`	string	The error message
`code`	string	The error code
`issues`	object[]	An array of issues that were responsible for the error
`issues[].message`	string

Example

Json

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}