latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Domains

Search domains

Finds the domains that match the given search criteria. Only parameters that are specified in this request and have not <code>null</code> values are used for filtering. All other parameters are ignored. By default a result containing 1000 domains is returned.

get/domains

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>. Cursor should be preferred over offset for better performance and stable results. It is forbidden to use both in the same request.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped. For cursor pagination this parameter is ignored and count is skipped.

cursorstring

Cursor for the current page of results. To retrieve the first page with cursor pagination you need to pass this parameter with an empty value (must be non-null). For the next pages, the value must be taken from the response (<code>nextCursor</code> property).

namestring

The name of the domain to search for

nameMatchMode'START' | 'END' | 'ANYWHERE' | 'EXACT'

The match mode used to compare <code>name</code>. If the match mode is <code>EXACT</code> the search is case-sensitive, otherwise the search is case-insensitive.

excludeMetaboolean

The exclude meta flag. If this is set to true then the meta domains will not be returned (meta domains are i.e. domains not created manually by the user).

communityIdstring uuid

The ID of the community to find the domains in

typeIdstring uuid

The ID of the domain type to search for. Returned domains are of this type. Ignored if typeIds is also provided.

typeIdsstring[]

The IDs of the domain types to search for. Returned domains are of these types. When provided, typeId is ignored.

typePublicIdstring

The public ID of the domain type to search for. Returned domains are of this type

includeSubCommunitiesboolean

Whether to include sub-communities. When true, direct sub-communities of the community referenced by the communityId parameter are also included in the search. Sub-communities of those sub-communities are not included.

Response

OK - The request has succeeded.

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.