FormGroups: GetFormGroups

Returns the company form groups to which the current user has access.

Permissions

Rooms Version 5: You must be Admin to use this method.

Rooms Version 6: You must have a role for which the canManageFormGroups permission is set to true.

Request

HTTP request

GET /restapi/v2/accounts/{accountId}/form_groups

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

(Required) The globally unique identifier (GUID) for the account.

Optional Query Parameters
countinteger

(Optional) The number of results to return. This value must be a number between 1 and 100 (default).

startPositioninteger

(Optional) The starting zero-based index position of the results set. The default value is 0.

Responses

CodeDescriptionReference
200

Successfully retrieved Form Groups.

FormGroupSummaryList
400

Bad request. See ErrorCode and Message for details

ApiError
401

Not authorized to make this request.

ApiError

SDK Method

Forms::GetFormGroups

Definitions

ApiError

This object describes errors that occur. It is valid only for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

FormGroupSummary

Contains details about a form group.

formGroupIdstring

The id of the form group.

Example: 7b879c89-812b-493f-9d28-819d6a85e0a1

namestring

The name of the form group.

Example: Apartment Rental

formCountinteger

The number of forms in the form group.

Example: 10

FormGroupSummaryList

Contains a list of form groups.

formGroups[FormGroupSummary]

A list of form groups.

resultSetSizeinteger

The number of results returned in this response.

startPositioninteger

The starting zero-based index position of the results set. When this property is used as a query parameter, the default value is 0.

endPositioninteger

The last zero-based index position in the result set.

nextUristring

The URI for the next chunk of records based on the search request. This property is null for the last set of search results.

priorUristring

The URI for the previous chunk of records based on the search request. This property is null for the first set of search results.

}} />