Skip to main content
GET
Get groups

Авторизации

Authorization
string
header
обязательно

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Заголовки

X-Tenant-Id
integer

Компания, в контексте которой выполняется запрос — её id из GET /v1/tenant/. Пользователь должен состоять в этой компании: чужой id доступа к данным не даёт. Без заголовка компания определяется по домену запроса.

Параметры запроса

available
boolean
category
integer
category__in
integer[]

Несколько значений могут быть разделены запятыми.

disable__isnull
boolean
disabled
boolean
discount
integer
discount__in
integer[]

Несколько значений могут быть разделены запятыми.

end_at
string<date-time>

Конец окна доступности. Момент времени или дата, от которой берётся полночь. По умолчанию — текущий момент.

free
boolean
has_sublease
boolean
id
integer
id__exclude
integer[]

Несколько значений могут быть разделены запятыми.

id__in
integer[]

Несколько значений могут быть разделены запятыми.

ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

pageSize
integer

Number of results to return per page.

rental_point
integer
saleable
boolean

A search term.

shareable
boolean
start_at
string<date-time>

Начало окна доступности. Момент времени или дата, от которой берётся полночь. По умолчанию — текущий момент.

status
number
type
enum<integer>
  • 0 - Аренда
  • 1 - Продажа
Доступные опции:
0,
1

Ответ

200 - application/json
count
integer
обязательно
Пример:

123

results
object[]
обязательно
next
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Пример:

"http://api.example.org/accounts/?page=2"