跳转到主要内容
GET
Lists the projects visible to the authenticated service provider, newest activity first.

授权

X-API-Key
string
header
必填

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.

查询参数

Cursor
string

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

PageSize
integer<int32>
默认值:50

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

SortBy
string
默认值:updatedOn

Sort field: updatedOn (default) or createdOn.

SortOrder
string
默认值:desc

Sort direction: asc or desc (default).

StatusIds
string

Comma-separated project status ids: 1 Not started, 2 In progress, 3 On hold, 4 Completed, 5 Closed. Any other id is a 400. Omitted returns every status.

ClientIds
string

Comma-separated client ids.

TypeIds
string

Comma-separated project type ids (Guids).

LeadAssigneeIds
string

Comma-separated lead assignee (technician) ids.

TagIds
string

Comma-separated tag ids (Guids).

GroupIds
string

Comma-separated technician group ids.

Query
string

Keyword matched against the project title, number and display number.

UpdatedSince
string<date-time>

Keeps only projects updated at or after this instant (UTC).

UpdatedBefore
string<date-time>

Keeps only projects updated strictly before this instant (UTC).

CreatedSince
string<date-time>

Keeps only projects created at or after this instant (UTC).

CreatedBefore
string<date-time>

Keeps only projects created strictly before this instant (UTC).

TargetDateAfter
string<date-time>

Keeps only projects with a target date at or after this instant (UTC). A project with no target date matches neither bound.

TargetDateBefore
string<date-time>

Keeps only projects with a target date strictly before this instant (UTC).

响应

OK

StatusCode
enum<integer>
可用选项:
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[]