Skip to main content
GET
Lists agreements

Authorizations

Authorization
string
header
required

Bearer token authentication

Headers

Authorization
string
required

Query Parameters

page
integer
per_page
integer
language_iso
string
sorted_by
string

Sort the records by one of the supported attributes:

  • title
  • active
  • required_on_checkout
  • created_at
  • updated_at The sort attribute should be followed by one of the order directives: '_asc', '_desc'
search_query
string

Filter agreements with their title

status
enum<string>

Filter by status

Available options:
active,
inactive

Response

object | null

Success

agreements
(object | null)[] | null
meta
object