Skip to main content
GET
getLists
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.

FlowClient Credentials
Token URL
https://crm.cynopsis.co/oauth/token

Headers

X-Domain-ID
integer<int64>
required

X-Domain-ID

Query Parameters

offset
integer<int64>
paged
boolean
pageNumber
integer<int32>
pageSize
integer<int32>
sort.sorted
boolean
sort.unsorted
boolean
unpaged
boolean

Response

OK

content
OwnRestrictedListResponseDto · object[]
empty
boolean
first
boolean
last
boolean
number
integer<int32>
numberOfElements
integer<int32>
pageable
Pageable · object
size
integer<int32>
sort
Sort · object
totalElements
integer<int64>
totalPages
integer<int32>