Skip to content

Get

/marketing_permissions/get_marketing_permissions

Target audience: Developers

Get marketing permissions

Introduction

This endpoint return configured marketing permissions.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/marketing_permissions/get_marketing_permissions
Production https://backend.worldoftulo.com/external/api/v1/marketing_permissions/get_marketing_permissions

Requirements

Identity Scope
No /external/marketing_permission/r

Parameters

Name Required Type Description
active Optional Boolean Fetch active or inactive permissions. Leave empty to fetch both.
filter Optional String Filter by name.
Size range: ..1024

Curl Example

1
2
3
4
curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/marketing_permissions/get_marketing_permissions?active=true&filter=sms \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <access_token_with_identity>'

Response

Example response: Active true

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
HTTP 200
{
    "items": [
        {
            "id": "5b9707e317c0f859830000c3",
            "name": "Email",
            "type": "email",
            "active": true,
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc id tellus commodo, vestibulum eros quis, tempus erat. Ut tincidunt dictum sagittis.",
            "created": "2018-09-11T00:10:11Z",
            "checked_default": false,
            "general_communication": false,
            "titles": []
        },
        {
            "id": "5b9707e317c0f859830000c7",
            "name": "Sms",
            "type": "sms",
            "active": true,
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc id tellus commodo, vestibulum eros quis, tempus erat. Ut tincidunt dictum sagittis.",
            "created": "2018-09-11T00:10:11Z"
            "checked_default": false,
            "general_communication": false,
            "titles": []
        },
        {
            "id": "5b9707e317c0f859830000cb",
            "name": "Smoke signals",
            "type": "smoke_signals",
            "active": true,
            "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nunc id tellus commodo, vestibulum eros quis, tempus erat. Ut tincidunt dictum sagittis.",
            "created": "2018-09-11T00:10:11Z"
            "checked_default": false,
            "general_communication": false,
            "titles": []
        }
    ]
}

Errors

Example error response

1
2
3
4
5
HTTP 500 Internal Server Error
{
  "code": "internal_server_error",
  "message": "Ooops something unexpected happened"
}

HTTP 500 Internal Server Error

Name Type Description
internal_server_error Object Something unexpected happened server side