ENentur
Agreements

Retrieve one full agreement by agreement number

Fetches the current ACTIVE agreement for a business agreement number, including template element definitions with values from agreement details.

get/v1/agreements/{agreementNumber}/full

Request

  • Base URL
    https://api.entur.io/agreements
  • Auth
    • HTTP bearer
    • or API key in header et-client-name

Path parameters

agreementNumberinteger required

Agreement Number

Response

Successful retrieval

idinteger required
agreementNumberinteger required
namestring required
notesstring required
status'ACTIVE' | 'DRAFT' | 'REVISING' | 'REVISED' | 'APPROVAL' | 'APPROVED' | 'REJECTED' | 'DEPRECATED' | 'TERMINATED' | 'PENDING' required
validFromstring date-time nullable
validTostring date-time nullable
createdAtstring date-time required
changedAtstring date-time required
templateIdinteger required
sourceAgreementIdinteger nullable

Internal ID of another agreement: the source agreement this agreement was migrated from. Null if not migrated.

processingStatus'NEW' | 'PROCESSING' | 'PROCESSED' | 'FAILED' | 'ROLLBACK_FAILED' required
processedAtstring date-time nullable
commandParametersobject required

Per-command parameters grouped by command configuration id

eventParametersobject required

Per-event parameters grouped by event configuration id

Changes

No recorded changes to this operation across all 1 revision of this API.