Skip to content
Tallyraydocs

Flows, active ones unless status says

GET
/v1/buyer/flows
curl --request GET \
  --url 'https://example.com/v1/buyer/flows?sort=id' \
  --header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. API keys with the buyer:read or buyer:write scope.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

status
string
q
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
created_at
required
string format: date-time
default_paths
required
Array<object>
object
id
required
integer format: int64
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
offers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
paused
required
boolean
redirect_mode
required
string | null
Allowed values: http meta double_meta
steps
required
Array<object>
object
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
weight
required
integer format: int32
id
required
integer format: int64
name
required
string
rules
required
Array<object>
object
conditions
required
Array<object>
object
dimension
required
string | null
Allowed values: country region city isp asn connection_type carrier device_type device_brand os os_version browser browser_version language referrer_domain ip weekday hour token visitor_type
operator
required
string | null
Allowed values: in not_in contains not_contains at_least below
param
required
string
time_zone
required
string
values
required
Array<string>
window_seconds
required
integer | null format: int64
id
required
integer format: int64
name
required
string
paths
required
Array<object>
object
id
required
integer format: int64
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
offers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
paused
required
boolean
redirect_mode
required
string | null
Allowed values: http meta double_meta
steps
required
Array<object>
object
landers
required
Array<object>
object
id
required
integer format: int64
weight
required
integer format: int32
name
required
string
weight
required
integer format: int32
paused
required
boolean
sequence
required
integer format: int64
status
required
string | null
Allowed values: active archived
sticky
required
boolean
updated_at
required
string format: date-time
workspace_id
required
integer format: int64
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example 

{
  "data": [
    {
      "default_paths": [
        {
          "redirect_mode": "http"
        }
      ],
      "rules": [
        {
          "conditions": [
            {
              "dimension": "country",
              "operator": "in"
            }
          ],
          "paths": [
            {
              "redirect_mode": "http"
            }
          ]
        }
      ],
      "status": "active"
    }
  ]
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}