Skip to main content
GET
Show an agreement

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or a member token. The credential alone identifies the member and company.

Headers

If-None-Match
string

A previously returned ETag. Authentication runs before a 304 is considered.

Path Parameters

id
string<uuid>
required

Public id of an agreement that applies to the member.

Response

The agreement.

One agreement with its full text.

status
integer
required
data
object
required

An agreement with its full text.

meta
object
required

Envelope metadata present on every response.