Invitations

Check if a profile is allowed to invite an address or ENS name

get
Query parameters
senderProfileIdinteger · max: 2147483647Optional
addressOrEnsstringRequired
Responses
200

Successful response

application/json
Responseany of
or
get
GET /api/v2/invitations/check HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "canInvite": true,
  "address": "text"
}

Get pending invitations for an address

get

Retrieve a list of Ethos profiles that have an active invitation sent to the specified address. Each item includes a simulated score impact that shows how accepting the invitation would affect the recipient score. > ⚠️ Warning: This is a beta endpoint. It is not guaranteed to be stable and may change or break without notice.

Path parameters
addressstringRequired
Responses
200

Successful response

application/json
get
GET /api/v2/invitations/pending/{address} HTTP/1.1
Host: api.ethos.network
Accept: */*

[
  {
    "id": 1,
    "impact": {
      "value": 1,
      "relativeValue": 1,
      "impact": "POSITIVE",
      "adjustedRecipientScore": 1
    },
    "inviterUser": {
      "id": 1,
      "profileId": 1,
      "displayName": "text",
      "username": "text",
      "avatarUrl": "https://example.com",
      "description": "text",
      "score": 1,
      "status": "ACTIVE",
      "userkeys": [
        "text"
      ],
      "xpTotal": 1,
      "xpStreakDays": 1,
      "links": {
        "profile": "https://example.com",
        "scoreBreakdown": "https://example.com"
      },
      "stats": {
        "review": {
          "received": {
            "negative": 1,
            "neutral": 1,
            "positive": 1
          }
        },
        "vouch": {
          "given": {
            "amountWeiTotal": 1,
            "count": 1
          },
          "received": {
            "amountWeiTotal": 1,
            "count": 1
          }
        }
      }
    }
  }
]
PreviousInternalNextLlm