This document is generated by Aladia.

Aladia API

Search Profiles

Developing

GET

/profiles/search

This endpoint searches profiles based on their first name, last name, email, IDs, and usernames.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.aladia.io/v2/profiles/search?scope=&scopeId&followSuggestion=true&viewedProfiles=true&type&text&featuredUsers&city=Addis Ababa&country=Ethiopia&skill&jobRole&companyName&degree&online&state=Amhara&certificateName&organizationId&limit=50&sortBy=&sortDirection=asc' \
--header 'apikey: '

Response Example

200 - Success

{
  "data": [
    {
      "id": "670775694daebf393b266ea1",
      "username": "Elinor.Hyatt",
      "firstName": "Morgan",
      "lastName": "Hansen",
      "picture": null,
      "cover": null,
      "email": "Darryl.Johnson87@gmail.com",
      "phoneNumber": "369-712-0834 x36791",
      "type": "teacher",
      "contactsVisibility": {
        "email": true,
        "phoneNumber": false,
        "address": false,
        "birthDate": true
      },
      "setupProcess": {
        "step": -20590379.949734405,
        "section": -2605319.89776358
      },
      "lastActivity": "Duis ipsum esse elit pariatur",
      "timezone": "Europe/Budapest",
      "online": true,
      "birthAddress": {
        "country": "Belgium",
        "city": "McLean",
        "state": "tempor Excepteur"
      },
      "settings": {
        "theme": "light",
        "language": "in dolore do"
      },
      "preferences": {
        "payements": {
          "transactions": {
            "columns": {
              "name": "payment-method",
              "visibility": true
            }
          },
          "subscriptions": {
            "columns": {
              "name": "next-installment",
              "visibility": true
            }
          },
          "payouts": {
            "columns": {
              "name": "status",
              "visibility": true
            }
          },
          "customers": {
            "columns": {
              "name": "customer-profile",
              "visibility": false
            }
          }
        },
        "chats": {
          "color": "cyan",
          "width": 12668947.46915792
        },
        "calenders": {
          "viewMode": "partial"
        }
      },
      "numberOf": {
        "followers": 59725820.17650017,
        "followings": -97700855.26674679,
        "reviews": -91547137.09644385,
        "posts": 95328210.49418524,
        "solved": 20911608.08371471
      },
      "createdAt": "2000-07-02",
      "updatedAt": "1955-11-12",
      "fullName": "Gwen Cormier",
      "hasActiveStory": false,
      "isFollowing": false,
      "entityType": "organization"
    }
  ],
  "cursor": {
    "next": "in anim quis ea",
    "prev": null,
    "totalItems": 39663394
  }
}

Request

Query Params

username

string

optional

firstName

string

optional

lastName

string

optional

string

optional

ids

array[string]

optional

Example:

[""]

scope

string

optional

course, chat-room, space or calendar

scopeId

string

optional

Id of the specified scope. Then members of this scopeId will be excluded from the response.

followSuggestion

boolean

optional

true, false

Example:

true

viewedProfiles

boolean

optional

true, false

Example:

true

type

string

optional

user, teacher

text

string

optional

search using fistName, lastName, username or email

featuredUsers

boolean

optional

city

string

optional

Example:

Addis Ababa

country

string

optional

Example:

Ethiopia

skill

string

optional

jobRole

string

optional

companyName

string

optional

degree

string

optional

online

boolean

optional

state

string

optional

Example:

Amhara

certificateName

string

optional

organizationId

string

optional

limit

integer

optional

Number of documents per page in the response

Default:

sortBy

string

optional

Optional field to be used as a sorting reference

sortDirection

enum<string>

optional

Set the results in ascending (asc) or descending (desc) direction

Allowed values:

ascdesc

Default:

asc

Header Params

apikey

string

optional

Example:

Responses

🟢200Success

application/json

Body

data

array[object (profile.rto) {24}]

optional

string

optional

ID of the user

Example:

670775694daebf393b266ea1

username

string

optional

unique username

firstName

string

optional

first name of profile

lastName

string

optional

last name of profile

picture

optional

url avatar image

cover

optional

url cover image

string <email> | null

optional

Email of the profile

phoneNumber

string | null

optional

Phone number

type

enum<string>

optional

user or teacher

Allowed values:

userteacher

contactsVisibility

object (contactsVisibility.model)

optional

Show or hide contact details

setupProcess

object (setupProcess.model)

optional

progress onboarding

lastActivity

string

optional

Last activiy by the user

timezone

string | null

optional

timezone of the user of this profile

online

boolean

optional

birthAddress

optional

settings

object (settings.model)

required

preferences

object (preferences.model)

optional

Profile preferences

numberOf

object (profilesNumberOf.model)

optional

createdAt

string <date>

optional

date creation

updatedAt

string <date>

optional

date edit

fullName

string

required

isFollowing

boolean

optional

entityType

enum<string>

optional

profile / organization

Allowed values:

profileorganization

story

object (profileStory.rto)

required

cursor

object (cursor)

optional

string | null

required

string | null

required

totalItems

integer

required

🟠422Parameter Error

Modified at 2025-04-09 12:57:20

List All Profiles

Retrieve a Profile