Skip to content
Tallyraydocs

The workspace's outside addresses, which get reports once their owners confirm them: its owner's alone, as personal data

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

Who: a workspace’s owner. Not for API keys.

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
asked
required
integer format: int32
asked_at
required
string | null format: date-time
confirmed_at
required
string | null format: date-time
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
email
required
string
id
required
integer format: int64
schedules
required
integer format: int32
status
required
string | null
Allowed values: asked confirmed lapsed
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": [
    {
      "created_by": {
        "kind": "user"
      },
      "status": "asked"
    }
  ]
}

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"
  }
}