HTTP Identity Find


Identity Find works slightly differently to other "Find" endpoints:

  • Passing no filter will return a single item - your Identity
  • Passing a filter string allows you to search for other users on the system. However, only name and id fields will be returned. This is the minumum you need when creating Groups or Shares
  • Results will be locked to limit == 1

Request


GET https://api.flowthings.io/v0.1/<account_id>/identity?filter=<filter>

Params

  • filter - For defining the parameters of the search, see the Flow Filter Language documentation for more details

Headers

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

Example

GET https://api.flowthings.io/v0.1/<account_id>/identity?filter=name=="alice"

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." ]
  },
  "body": [{
    "id": "i53b1d1600cf27b75148de0ac",
    "name" : "alice"
  }]
}