About
Flows are retrieved using the following request.
Resource URI
Complete details about your flows are requested with the following request.
GET
/v2/Properties/[PropertySid]/Flows
Request
URI Parameters
| Parameter | Type | Description |
|---|---|---|
| PropertySid | string | Property secure identification to retrieve flows. |
Optional Include Parameters
These parameters are only associated with the request for a list of flows records. Results can be filtered with any number of the following parameters.
| Parameter | Type | Description |
|---|---|---|
| Results_Count | int | Limit the results to this number. Default result count is a limit of 50. |
| Results_Skip | int | Return results after the specified index. This enables custom pagination of results. Default is 0 |
Response
200 – OK
Our service will respond to every flows request with JSON formatted data. Requests for flows will respond with a list of objects containing the following parameters.
Common Response Parameters
| Parameter | Type | Description |
|---|---|---|
| PropertySid | string | The property identification associated with the flow. |
| ConfigId | string | The id of the config |
| Revision | string | The revision of the config |
| Name | string | The friendly name of the config |
| Type | string | The type of the config |
| LastUpdated (Unix timestamp) |
unsigned integer | The time flow config was last updated (UTC) |
400 - Error
For error codes and messages, please refer to the REST API Error Codes page.