Get the list of users

get

https://api-feedback.satisfactory.fr/v2/api/users

Retrieve information about all the users of the platform. Each call returns at most 50 users.

Request

Query Parameters

from

integer

Rank of the first user returned in the response. The rank starts from 0.

string

Used to search for users that have a specific keyword in their email addresses or in their names.

size

integer

Number of users returned in the response

Headers

Authorization

string

required

API Key

Responses

200

401

Body

@context

string

@id

string

@type

string

hydra:totalItems

integer

hydra:member

array[object]

@type

string

@id

string

The ID of the user

name

string

The name of the user

string

The email address of the user

language

string

The language set for the user

perimeter

array[object]

Information about the perimeter set for the user

profile

object

Information about the profile of the user on the platform

comparisonPerimeter

null or object

The comparison perimeter of the user.
This is useful only if you have configured the metadata in the "perimeter" field.

perimeterName

string

The name of the perimeter

perimeterJoin

string

The operator applyed when the perimeter is set with several metadatas

notificationAlert

boolean

The status of the alert notification

notificationReport

boolean

The status of the new report notification

notificationScoreSat

boolean

The status of the key indicators scores warning notification

notificationNbResp

boolean

The status of the respondent numbers change notification

notificationWeakSig

boolean

The status of the comments notification

notificationRed

boolean

The status of attributes in the warning state notification

status

any

The status of the user

Allowed values:

ActiveInactive

accessToken

string

The Access Token of the user.
It is used to identify the user when performing API calls.

lastConnexion

null or string

The date of the last connection

hydra:view

object

@id

string

@type

string

hydra:search

object

@type

string

hydra:template

string

hydra:variableRepresentation

string

hydra:mapping

array[object]

Parameters

curl --request GET \
  --url https://api-feedback.satisfactory.fr/v2/api/users \
  --header 'Accept: application/json' \
  --header 'Authorization: '

Response Example

1
{
2
  "@context": "/api/contexts/User",
3
  "@id": "/api/users",
4
  "@type": "hydra:Collection",
5
  "hydra:totalItems": 50,
6
  "hydra:member": [
7
    {
8
      "@type": "UserDto",
9
      "@id": "/api/.well-known/genid/{generated_id}",
10
      "id": "00000000-0000-0000-0000-000000000000",
11
      "name": "John Doe",
12
      "email": "email@jd.com",
13
      "language": "fr",
14
      "perimeter": [],
15
      "profile": {
16
        "id": "00000000-0000-0000-0000-000000000000",
17
        "name": "administrator",
18
        "features": {
19
          "myOverview": 0,
20
          "accountManagement": 0,
21
          "interactionManagement": 0,
22
          "attributeManagement": 0,
23
          "keyIndicatorManagement": 0,
24
          "commentManagement": 0,
25
          "metadataManagement": 0,
26
          "notification": 0,
27
          "change_red": 0,
28
          "score_sat": 0,
29
          "weaksignal": 0,
30
          "number_responses": 0,
31
          "profilManagement": 0,
32
          "userConsultation": 0,
33
          "userManagement": 0,
34
          "userDelete": 0,
35
          "userLogAs": 0,
36
          "alertManagement": 0,
37
          "monitoringConsultation": 0,
38
          "monitoringExport": 0,
39
          "attributeKeywordManagement": 0,
40
          "responseLibraryManagement": 0,
41
          "historyRecoveryManagement": 0,
42
          "conceptManagement": 0,
43
          "benchmarkManagement": 0,
44
          "verbatims": 0,
45
          "keyIndicator": 0,
46
          "export": 0,
47
          "clientRelationship": 0,
48
          "feedbackTreatment": 0,
49
          "actionPlan": 0,
50
          "support": 0,
51
          "myAccount": 0,
52
          "import": 0,
53
          "log": 0,
54
          "client": 0,
55
          "deleteExperience": 0,
56
          "overSolicitation": 0,
57
          "dashboardManagement": 0,
58
          "clientRawData": 0,
59
          "NewsFeed": 0,
60
          "accessPrivateData": 0,
61
          "specificPeriodManagement": 0,
62
          "metadataAnalysis": 0
63
        },
64
        "initialPage": "/",
65
        "profileReference": {
66
          "id": 0,
67
          "name": "director_of_site"
68
        }
69
      },
70
      "comparisonPerimeter": null,
71
      "perimeterName": "administrator",
72
      "perimeterJoin": "AND",
73
      "notificationAlert": true,
74
      "notificationReport": true,
75
      "notificationScoreSat": true,
76
      "notificationNbResp": true,
77
      "notificationWeakSig": true,
78
      "notificationRed": true,
79
      "status": "Inactive",
80
      "accessToken": "{generated_token}",
81
      "lastConnexion": null
82
    }
83
  ],
84
  "hydra:view": {
85
    "@id": "/api/users",
86
    "@type": "hydra:PartialCollectionView"
87
  },
88
  "hydra:search": {
89
    "@type": "hydra:IriTemplate",
90
    "hydra:template": "/api/users{?order[createdAt],profile,profile[],search_name,search_email}",
91
    "hydra:variableRepresentation": "BasicRepresentation",
92
    "hydra:mapping": [
93
      {
94
        "@type": "IriTemplateMapping",
95
        "variable": "order[createdAt]",
96
        "property": "createdAt",
97
        "required": false
98
      }
99
    ]
100
  }
101
}