User
Query user profiles
Queries user profiles and stores the result in a batch. Results are fetched from this batch one page at a time via subsequent requests.
BatchId is mandatory when fetching any page other than the first page.
If no BatchId is provided for the first page, a new batch is created and the id for that batch can be found in the response.
Parameters for "Query user profiles"
POST/API/User/Query/{page}
Request Example
curl -X POST 'https://mgmtapi.geins.io/API/User/Query/{page}' \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic [USER-CREDENTIALS-BASE64-ENCODED]' \
-H 'X-ApiKey: {MGMT_API_KEY}'\
-d '{
"CreatedBefore": "string",
"CreatedAfter": "string",
"UpdatedAfter": "string",
"IncludeInactive": true,
"BatchId": "00000000-0000-0000-0000-000000000000",
"UserId": 0,
"Email": "string"
}'
import axios from 'axios';
const config = {
method: 'POST',
url: 'https://mgmtapi.geins.io/API/User/Query/{page}',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
'X-ApiKey': '{MGMT_API_KEY}'
},
data: {
"CreatedBefore": "string",
"CreatedAfter": "string",
"UpdatedAfter": "string",
"IncludeInactive": true,
"BatchId": "00000000-0000-0000-0000-000000000000",
"UserId": 0,
"Email": "string"
}
};
axios.request(config)
.then(response => response.data)
.catch(error => console.error(error));
fetch('https://mgmtapi.geins.io/API/User/Query/{page}', {
method: 'POST',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
'X-ApiKey': '{MGMT_API_KEY}'
},
body: JSON.stringify({
"CreatedBefore": "string",
"CreatedAfter": "string",
"UpdatedAfter": "string",
"IncludeInactive": true,
"BatchId": "00000000-0000-0000-0000-000000000000",
"UserId": 0,
"Email": "string"
})
})
.then(res => res.json())
.then((response) => response)
.catch(console.error);
import requests
url = "https://mgmtapi.geins.io/API/User/Query/{page}"
headers = {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Basic [USER-CREDENTIALS-BASE64-ENCODED]',
'X-ApiKey': '{MGMT_API_KEY}'
}
payload = {
"CreatedBefore": "string",
"CreatedAfter": "string",
"UpdatedAfter": "string",
"IncludeInactive": true,
"BatchId": "00000000-0000-0000-0000-000000000000",
"UserId": 0,
"Email": "string"
}
response = requests.POST(url, json=payload, headers=headers)
print(response.json())
package main
import (
"bytes"
"fmt"
"io"
"net/http"
)
func main() {
url := "https://mgmtapi.geins.io/API/User/Query/{page}"
payload := []byte(`{
"CreatedBefore": "string",
"CreatedAfter": "string",
"UpdatedAfter": "string",
"IncludeInactive": true,
"BatchId": "00000000-0000-0000-0000-000000000000",
"UserId": 0,
"Email": "string"
}`)
req, _ := http.NewRequest("POST", url, bytes.NewBuffer(payload))
req.Header.Add("Accept", "application/json")
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Authorization", "Basic [USER-CREDENTIALS-BASE64-ENCODED]")
req.Header.Add("X-ApiKey", "{MGMT_API_KEY}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
using System.Text;
using System.Text.Json;
using System.Net.Http;
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Basic [USER-CREDENTIALS-BASE64-ENCODED]");
client.DefaultRequestHeaders.Add("X-ApiKey", "{MGMT_API_KEY}");
var body = new
{
CreatedBefore = "string",
CreatedAfter = "string",
UpdatedAfter = "string",
IncludeInactive = true,
BatchId = "00000000-0000-0000-0000-000000000000",
UserId = 0,
Email = "string"
};
var jsonContent = JsonSerializer.Serialize(body);
var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
var response = await client.POSTAsync("https://mgmtapi.geins.io/API/User/Query/{page}", content);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
Response
{
"PageResult": {
"BatchId": "00000000-0000-0000-0000-000000000000",
"Page": 0,
"RowCount": 0,
"PageCount": 0,
"PageSize": 0,
"HasMoreRows": true
},
"Resource": [
{
"UserId": 0,
"SiteId": 0,
"Email": "string",
"FirstName": "string",
"LastName": "string",
"PhoneNr": "string",
"MobilePhoneNr": "string",
"Company": "string",
"Address": "string",
"Address2": "string",
"Address3": "string",
"DoorCode": "string",
"PersonalId": "string",
"Birthyear": "string",
"Zip": "string",
"City": "string",
"CareOf": "string",
"Country": "string",
"State": "string",
"CustomerGroupId": 0,
"CustomerGroupName": "string",
"MemberId": 0,
"MemberType": "string",
"CountryId": 0,
"UserTypeId": 0,
"GenderType": 0,
"MemberDiscount": 0,
"Newsletter": true,
"Blacklisted": true,
"Active": true,
"CreatedOn": "string",
"UpdatedOn": "string",
"MetaData": "string",
"BlacklistedOn": "string",
"BlacklistReason": "string"
}
],
"Message": "string",
"Details": [
"string"
]
}
{
"Message": "string",
"Details": [
"string"
]
}