Skip to content

Get

/useragreements

Target audience: Developers

Introduction

Retrieves list of all user agreements for the organisation.

URI

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

Requirements

Identity Scope
No /external/organisation/r

Curl Example

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

Response

Successful response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
HTTP 200
{
    "items": [
        {
            "id": "5dd7ce036e95526461b33184",
            "name": "User agreement", 
            "markup": "I agree to the terms specified...",
            "active": true,
            "created": "2019-11-22T13:01:07+01:00"
        },
        {
            "id": "5dd7ce036e95526461b33185",
            "name": "User agreement", 
            "markup": "I agree to the terms specified...", 
            "active": false, 
            "created": "2019-11-22T13:01:07+01:00"
        }
    ]
}

Errors

Example error response

1
2
3
4
5
6
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