Interface OrganizationsApiOrganizationsListRequest

Request parameters for organizationsList operation in OrganizationsApi.

Export

OrganizationsApiOrganizationsListRequest

Hierarchy

  • OrganizationsApiOrganizationsListRequest

Properties

filter?: string

JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;name&#39;, &#39;owner&#39;, &#39;slug&#39;, &#39;id&#39;].

Memberof

OrganizationsApiOrganizationsList

name?: string

A simple equality filter for the name field

Memberof

OrganizationsApiOrganizationsList

owner?: string

A simple equality filter for the owner field

Memberof

OrganizationsApiOrganizationsList

page?: number

A page number within the paginated result set.

Memberof

OrganizationsApiOrganizationsList

pageSize?: number

Number of results to return per page.

Memberof

OrganizationsApiOrganizationsList

search?: string

A search term. Available search_fields: (&#39;name&#39;, &#39;owner&#39;, &#39;slug&#39;)

Memberof

OrganizationsApiOrganizationsList

slug?: string

A simple equality filter for the slug field

Memberof

OrganizationsApiOrganizationsList

sort?: string

Which field to use when ordering the results. Available ordering_fields: [&#39;name&#39;, &#39;owner&#39;, &#39;slug&#39;, &#39;id&#39;]

Memberof

OrganizationsApiOrganizationsList

Generated using TypeDoc