Skip to content

Get administrators

/

Target audience: Developers

1
Release version: 4.6.1

Get administrators

Introduction

This endpoint returns a list of all administrators, including their respective groups for the organisation.

URI

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

Requirements

Identity Scope
Yes /external/admin/r

Curl example

1
2
3
4
curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/admin \
  --header 'authorization: Bearer <token-with-identity>' \
  --header 'content-type: application/json'

Parameters

Parameter Description Required Format Type
group The name of the group the user should be included in No String
Response
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
HTTP 200 OK
{
  "items": [
    {
      "group": "Superuser",
      "created": "2022-10-26T00:00:00",
      "account_id": "adf09kadf98931413941334134",
      "contact_email": "test-user@adeprimo.se",
      "name": "Test User"
    },
    {
      "group": "Customer service",
      "created": "2022-10-26T00:00:00",
      "account_id": "adf09kadf98931413941334134",
      "contact_email": "test-user@adeprimo.se",
      "name": "Test User"
    }
  ]
}

Errors

This API uses the common error conventions of the Payway API

See common error responses