Skip to main content
GET
Get goal

Authorizations

Authorization
string
header
required

Environment AUTH_KEY. Full ledger access and primary API-key administration. Not OAuth or JWT.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

include_history
boolean

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

history_limit
integer

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required range: 1 <= x <= 100
history_before_version
integer

Exactly one parameter; booleans are true/false, arrays are comma-separated. Empty values are rejected.

Required range: x <= 2147483647

Response

Successful domain response

catalog_version
string
required
Allowed value: "1.0.4"
goal
object
required
history
object[]
Maximum array length: 100
history_has_more
boolean
history_next_version
integer | null
Required range: 0 < x <= 2147483647