HTTP Group Find


Request


GET https://api.flowthings.io/v0.1/<account_id>/group?filter=<filter>&start=<start>&limit=<limit>&sort=<sort>&order=<order>&refs=<refs>

Params

  • start - For the starting index of the search, default is 0.
  • limit - To limit the maximum number of objects returned in the response, the default is 20.
  • sort - For selecting a member field to sort the search results. Default is creationDate.
  • order - For selecting the order of the sort, options are ‘asc’ (ascending) or ‘desc’ (descending). Default is desc.
  • filter - For defining the parameters of the search, see the Flow Filter Language documentation for more details.
  • refs - Adds objects related to the groups retrieved by the find to the response head. By default references are off (0). Turning references on (1) will add the Groups' Identities to the response head, keyed by id.

Headers

NameDescription
Content-Typeapplication/json
X-Auth-TokenAuthentication Token

Example

GET https://api.flowthings.io/v0.1/<account_id>/group?filter=creatorId=="i549495f90cf2dc116f90bb3f"&start=0&limit=10&sort=periodicity&order=asc

Response


HTTP Codes

CodeDescription
200Request Successful
400Bad Request
401Unauthorized
503Service Unavailable

Example

{
  "head": {
    "status": 200,
    "ok": true,
    "errors": [],
    "messages": [ "Your request has been processed successfully." ],
    "references": {}
  },
  "body": [{
    "creationDate": 1421427836714,
    "creatorId": "i549495f90cf2dc116f90bb3f",
    "displayName": "Develeper Group",
    "description": "A group for our flowthings developers",
    "id": "g54b9447c0cf2714b9fae943a",
    "memberIds": ["i549495f90cf2dc116fe5aa21","i549868170cf2228ced3b8a99"]
  },{
    "creationDate": 1421427941613,
    "creatorId": "i549495f90cf2dc116f90bb3f",
    "displayName": "Administrator Group",
    "description": "A group for our flowthings administrators",
    "id": "g54b944e50cf2714b9fae9463",
    "memberIds": ["i549495f90cf2dc116f90bb35","i549868170cf2228ced714f66"]
  }]
}