Invitations

Get a list of invitations

get
Query parameters
senderProfileIdinteger · max: 2147483647Optional
statusany ofOptional
or
string · enumOptionalPossible values:
limitinteger · max: 500OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

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

{
  "values": [
    {
      "invitation": {
        "id": 1,
        "senderProfileId": 1,
        "recipientAddress": "text",
        "status": "ACCEPTED",
        "recipientScoreImpact": {
          "value": 1,
          "impact": "POSITIVE"
        },
        "senderScoreImpact": {
          "value": 1,
          "impact": "POSITIVE"
        },
        "dateInvited": "text",
        "dateAccepted": "text"
      },
      "invitedUser": {
        "id": 1,
        "profileId": 1,
        "displayName": "text",
        "username": "text",
        "avatarUrl": "https://example.com",
        "description": "text",
        "score": 1,
        "status": "ACTIVE",
        "userkeys": [
          "text"
        ],
        "xpTotal": 1,
        "xpStreakDays": 1,
        "xpRemovedDueToAbuse": true,
        "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
            }
          }
        }
      }
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}

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
/invitations/check
GET /api/v2/invitations/check?addressOrEns=text 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.

Path parameters
addressstringRequired
Responses
200

Successful response

application/json
get
/invitations/pending/{address}
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,
      "xpRemovedDueToAbuse": true,
      "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
          }
        }
      }
    }
  }
]

Get a tree of accepted invitations

get
Path parameters
senderProfileIdinteger · max: 2147483647Required
Query parameters
depthinteger · max: 5OptionalDefault: 3
limitinteger · max: 500OptionalDefault: 50
offsetnumberOptionalDefault: 0
Responses
200

Successful response

application/json
get
/invitations/accepted/{senderProfileId}/tree
GET /api/v2/invitations/accepted/{senderProfileId}/tree HTTP/1.1
Host: api.ethos.network
Accept: */*

{
  "values": [
    {
      "id": 1,
      "senderProfileId": 1,
      "acceptedProfileId": 1,
      "level": 1,
      "user": {
        "id": 1,
        "profileId": 1,
        "displayName": "text",
        "username": "text",
        "avatarUrl": "https://example.com",
        "description": "text",
        "score": 1,
        "status": "ACTIVE",
        "userkeys": [
          "text"
        ],
        "xpTotal": 1,
        "xpStreakDays": 1,
        "xpRemovedDueToAbuse": true,
        "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
            }
          }
        }
      }
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 1
}
PreviousInternalNextLlm

Last updated