Skip to main content
GET
List organization surveys

承認

Authorization
string
header
必須

For authenticated requests, set the Authorization: Bearer your_api_key parameter in the header.
You can create and manage your API Keys by visiting the API Keys tab in the Settings page of your organization in Admina

パスパラメータ

organizationId
number
必須

クエリパラメータ

limit
number

Number of items to return per page. Default is 50, maximum is 200.

必須範囲: 1 <= x <= 200
:

50

cursor
string

Cursor for pagination. Use the nextCursor from previous response to get next page.

:

"eyJwYWdlIjoyLCJsaW1pdCI6NTB9"

sortBy
enum<string>

Field to sort by. Defaults to createdAt.

利用可能なオプション:
createdAt,
category,
status,
targetNumber,
scheduledLaunchAt,
deadlineAt,
publishedAt
sortOrder
enum<string>

Sort order. Defaults to DESC for createdAt.

利用可能なオプション:
DESC,
ASC

Search term to filter surveys by title, description, or content.

:

"Device Survey"

status
enum<string>[]

Filter surveys by status. Accepts multiple options.

利用可能なオプション:
draft,
published,
launched,
completed,
revoked
category
string

Filter surveys by category.

:

"device_ownership"

targetType
enum<string>

Filter surveys by target type.

利用可能なオプション:
employees,
devices,
services
launchDateRange
string

Filter surveys by scheduled launch date range. Format: YYYY-MM-DD:YYYY-MM-DD, separated by a colon.

:

"2024-01-01:2024-12-31"

deadlineDateRange
string

Filter surveys by deadline date range. Format: YYYY-MM-DD:YYYY-MM-DD, separated by a colon.

:

"2024-01-01:2024-12-31"

creationDateRange
string

Filter surveys by creation date range. Format: YYYY-MM-DD:YYYY-MM-DD, separated by a colon.

:

"2024-01-01:2024-12-31"

レスポンス

Successfully retrieved surveys

meta
object
必須
items
object[]
必須
read-only
最終更新日 2026年8月24日