Get users
Get users.
API is tenant specific if includeAllTenants is false.
Else, tenantId is ignored.
GET
/appid-{appId}/{tenantId}/usersAuthorization
api-keyAPI key · headerrequiredThe core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.
Path parameters
tenantIdstringThe tenant against which the request is made. If left empty, the default tenant will be used.
Query parameters
includeRecipeIdsstringThe param should take an array of comma seperated strings
paginationTokenstringlimitnumbertimeJoinedOrderstringAllowed:
ASCDESCemailstringphonenumberrecipestringproviderstringHeader parameters
cdi-versionstringX.Y of the X.Y.Z CDI version.
Responses
200User Pagination
statusstatusOKAllowed:
OKusersobject[]Show propertiesHide properties
Array of
objectuserauthRecipeUserShow propertiesHide properties
iduserIdisPrimaryUserbooleantenantIdstenantId[]timeJoinedtimeJoinedemailsemail[]phoneNumbersphoneNumber[]thirdPartyobject[]Show propertiesHide properties
Array of
objectidthirdPartyIduserIdthirdPartyUserIdloginMethodsobject[]Show propertiesHide properties
Array of
objecttenantIdstenantId[]recipeUserIduserIdverifiedbooleantimeJoinedtimeJoinedrecipeIdrecipeIdAllowed:
emailpasswordpasswordlessthirdpartyemailemailphoneNumberphoneNumberthirdPartyobjectShow propertiesHide properties
idthirdPartyIduserIdthirdPartyUserIdnextPaginationTokenpaginationToken400error code 400
string401error code 401
string404error code 404
string500error code 500
stringTry it
Server
Authorization
Parameters
Request
curl -X GET "/appid-{appId}/public/users" \
-H "api-key: YOUR_API_KEY"const response = await fetch("/appid-{appId}/public/users", {
method: "GET",
headers: {
"api-key": "YOUR_API_KEY"
}
});import requests
response = requests.get(
"/appid-{appId}/public/users",
headers={
"api-key": "YOUR_API_KEY"
},
)Response
{
"status": "OK",
"users": [
{
"user": {
"id": "fa7a0841-b533-4478-95533-0fde890c3483",
"isPrimaryUser": true,
"tenantIds": [
"customer1"
],
"timeJoined": 1623918032231,
"emails": [
"[email protected]"
],
"phoneNumbers": [
"+14155552671"
],
"thirdParty": [
{
"id": "google",
"userId": 106347997792363870000
}
],
"loginMethods": [
{
"tenantIds": [
"customer1"
],
"recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
"verified": true,
"timeJoined": 1623918032231,
"recipeId": "emailpassword",
"email": "[email protected]",
"phoneNumber": "+14155552671",
"thirdParty": {
"id": "google",
"userId": 106347997792363870000
}
}
]
}
}
],
"nextPaginationToken": "ZmE3YTA4ND...OzE2MjM5MTgwMzIyMzE="
}"string""Invalid API key""Not Found""Internal Error"