Skip to main content
GET
/
api
/
own-restricted-list
getLists
curl --request GET \
  --url https://api.artemis.cynopsis.co/api/own-restricted-list \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'
{
  "content": [
    {
      "active": true,
      "createdAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "domains": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "id": 123,
      "listName": "<string>",
      "nameOnList": 123,
      "updatedAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      }
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}
This endpoint retrieves a list of all Own Restricted Lists (ORL) within the current domain.

Description

  • Returns metadata for each restricted list created under the domain.
  • Each list may contain multiple names or entries, which can be managed separately.
  • Useful for displaying or selecting available restricted lists before adding or searching for names.

Notes

  • The response typically includes:
    • id — Unique identifier of the restricted list.
    • listName — Name of the restricted list.
    • active — Boolean indicating if the list is currently active.

Subsections


Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID
integer
required

X-Domain-ID

Query Parameters

offset
integer
paged
boolean
pageNumber
integer
pageSize
integer
sort.sorted
boolean
sort.unsorted
boolean
unpaged
boolean

Response

OK

content
OwnRestrictedListResponseDto · object[]
empty
boolean
first
boolean
last
boolean
number
integer
numberOfElements
integer
pageable
object
size
integer
sort
object
totalElements
integer
totalPages
integer