Get

/useragreements

Target audience: Developers

Get user agreements¶

Introduction¶

Retrieves list of all user agreements for the organisation.

URI¶

Environment	URI
Stage	https://payway-api.stage.adeprimo.se/external/api/v3/useragreements
Production	https://backend.worldoftulo.com/external/api/v3/useragreements

Requirements¶

Identity	Scope
No	`/external/useragreement/r`

Curl Example¶

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v3/useragreements \
  --header 'accept: application/json' \
  --header 'authorization: Bearer token' \

Response¶

Successful response¶

HTTP 200
{
    "items": [
        {
            "id": "5dd7ce036e95526461b33184",
            "name": "User agreement", 
            "payway_markdown": "I agree to the terms specified...",
            "html_markup": "I agree to the terms specified...",
            "active": true,
            "created": "2019-11-22T13:01:07+01:00",
            "must_always_accept": false
        },
        {
            "id": "5dd7ce036e95526461b33185",
            "name": "User agreement", 
            "payway_markdown": "*I agree* to the _terms_ specified...",
            "html_markup": "<b>I agree</b> to the <i>terms</i> specified...", 
            "active": false, 
            "created": "2019-11-22T13:01:07+01:00",
            "must_always_accept": false
        }
    ]
}

Errors¶

Example error response¶

HTTP 400 Bad Request
{
    "code": "invalid_parameter",
    "field": "account_id",
    "message": "Parameter must match format (/^[a-f\d]{24}$/)"
}

HTTP 400 Bad Request¶

Name	Type	Description
unknown_parameter	Object	One or more of the fields in the posted json was not recognized

HTTP 500 Internal Server Error¶

Name	Type	Description
internal_server_error	Object	Something unexpected happened server side