Skip to content
Tallyraydocs

Your workspace's event types, built-in ones first

GET
/v1/buyer/event-types
curl --request GET \
  --url 'https://example.com/v1/buyer/event-types?sort=code' \
  --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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
data
required
Array<object>
object
builtin
required
boolean
code
required
string
counted
required
boolean
created_at
required
string format: date-time
kind
required
string | null
Allowed values: lead registration sale deposit subscription rebill custom install reengagement
name
required
string
repeatable
required
boolean
sequence
required
integer format: int64
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": [
    {
      "kind": "lead"
    }
  ]
}

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