Retrieve a projects list for given search criteria

Request

Security

OAuth2(Required scopes: projects.read)

Query

offsetinteger, >= 0

A zero-based offset of the first item in the data collection to return.

limitinteger, [ 0 .. 50 ]

Limit the amount of items returned in the response. If the value exceeds the maximum, then the maximum value will be used.

Default:20

sortstring

The field to sort reponse items by.

Default:"-createdAt"

Enum:"-createdAt""+createdAt"

isLiveboolean

searchstring(Search text used to find projects.)

Search text is used against projects name and id

curl -i -X GET \
  'https://api.cloud.hypatos.ai/v2/projects?offset=0&limit=20&sort=-createdAt&isLive=true&search=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Projects list retrieved

Bodyapplication/json

dataArray of objects(Data)required

limitinteger(limit)required

Example:20

offsetinteger(offset)required

Example:0

totalCountinteger(Totalcount)required

Example:1

Response

{
  "data": [
    { … }
  ],
  "limit": 20,
  "offset": 0,
  "totalCount": 1
}