Pular para o conteúdo principal
GET
Lists the service provider's forms, most recently updated first.

Autorizações

X-API-Key
string
header
obrigatório

Your Gorelo API key. See Generate API key. If your data is hosted in Australia, click the base URL at the top of this page and select https://api.aue.gorelo.io.

Parâmetros de consulta

Cursor
string

Opaque pagination cursor from a previous page; omit for the first page.

PageSize
integer<int32>
padrão:50

Number of items per page, 1-200 (default 50). Out of range is rejected, not clamped.

SortOrder
string
padrão:desc

Sort direction by last update: asc or desc (default).

StatusIds
string

Comma-separated form status ids: 1 Active, 2 Archived. Omitted returns Active only (archived excluded). Any other id is a 400.

GroupIds
string

Comma-separated technician group ids; matches forms assigned to any of them.

TagIds
string

Comma-separated ticket tag ids; matches forms that apply any of them.

ClientIds
string

Comma-separated client ids; matches forms restricted to any of them.

AllowInPortal
boolean

Keeps only forms offered (true) or not offered (false) in the client portal.

Query
string

Keyword matched against the form title, case-insensitively.

Resposta

OK

StatusCode
enum<integer>
Opções disponíveis:
100,
101,
102,
103,
200,
201,
202,
203,
204,
205,
206,
207,
208,
226,
300,
301,
302,
303,
304,
305,
306,
307,
308,
400,
401,
402,
403,
404,
405,
406,
407,
408,
409,
410,
411,
412,
413,
414,
415,
416,
417,
421,
422,
423,
424,
426,
428,
429,
431,
451,
500,
501,
502,
503,
504,
505,
506,
507,
508,
510,
511
IsSuccess
boolean
Data
object[] | null
DataContext
object

The DataContext of a cursor-paginated success response: carries the paging metadata for the returned page.

Notifications
object[]