User

User module apis

This endpoint allows user to login through any crypto wallet.

POSThttps://api.questprotocol.xyz/api/users/wallet/login

Header parameters

Body

entityId*string

Example: "e-123"

walletAddress*string

Example: "e-x012121212"

signature*string

Example: "e-x012121212-121212"

token*string

Example: "token-used-for-signature"

refreshTokenstring

Example: "dumy-refresh-token"

Response

User already exists

Body

successboolean

Example: true

userIdstring

Example: "u-123user"

newUserboolean

Example: false

tokenstring

Example: "dumy-token"

refreshTokenstring

Example: "dumy-refresh-token"

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/wallet/login', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "entityId": "e-123",
      "walletAddress": "e-x012121212",
      "signature": "e-x012121212-121212",
      "token": "token-used-for-signature"
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "userId": "u-123user",
  "newUser": false,
  "token": "dumy-token",
  "refreshToken": "dumy-refresh-token"
}

This endpoint sends a login OTP to the given email address.

POSThttps://api.questprotocol.xyz/api/users/email-login/send-otp

Header parameters

Body

The response body

email*string

Example: "[email protected]"

Response

Successful response

Body

successboolean

Example: true

datastring

Example: "OTP sent successfully"

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/email-login/send-otp', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[email protected]"
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "data": "OTP sent successfully"
}

This endpoint verifies the login OTP sent via email.

POSThttps://api.questprotocol.xyz/api/users/email-login/verify-otp

Header parameters

Body

email*string

Example: "dummy-email"

otp*number

Example: 123456

entityIdstring

Example: "dummt-entityid"

Response

User already exists

Body

successboolean

Example: true

userIdstring

Example: "u-123user"

tokenstring

Example: "dumy-token"

refreshTokenstring

Example: "dumy-refresh-token"

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/email-login/verify-otp', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "otp": 123456,
      "email": "dummy-email"
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "userId": "u-123user",
  "token": "dumy-token",
  "refreshToken": "dumy-refresh-token"
}

This endpoint allows user to login through google.

POSThttps://api.questprotocol.xyz/api/users/google/login

Header parameters

Body

code*string

Example: "dummy-code"

redirectUri*string

Example: "https://redirect.com/google"

entityIdstring

Example: "dummt-entityid"

Response

User already exists

Body

successboolean

Example: true

userIdstring

Example: "u-123user"

tokenstring

Example: "dumy-token"

refreshTokenstring

Example: "dumy-refresh-token"

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/google/login', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "code": "dummy-code",
      "redirectUri": "https://redirect.com/google"
    }),
});
const data = await response.json();

Response

{
  "success": true,
  "userId": "u-123user",
  "token": "dumy-token",
  "refreshToken": "dumy-refresh-token"
}

This endpoint allows user to login through any external source.

POSThttps://api.questprotocol.xyz/api/users/external/login

Query parameters

Header parameters

Body

entityIdstring

Example: "e-123"

externalUserIdstring

Example: "example-x012121212"

walletAddressstring

Example: "abc@"

emailstring

Response

User created

Body

successboolean

Example: true

userIdstring

Example: "u-000001"

tokenstring

refreshTokenstring

Example: "dumy-refresh-token"

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/external/login?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "user-agent": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true,
  "userId": "u-000001",
  "token": "text",
  "refreshToken": "dumy-refresh-token"
}

Create new custom user.

This endpoint allows to create a custom user with custom userId and a platform name.

POSThttps://api.questprotocol.xyz/api/users/custom-ids

Header parameters

Body

customUserId*string

Example: "dummy-userid"

customPlatform*string

Example: "instagram"

entityId*string

Example: "dummt-entityid"

Response

User already exists

Body

successboolean

Example: false

userIdstring

Example: "dummy-userid"

newUserboolean

Example: false

errorstring

Example: "User already exists"

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/custom-ids', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "customUserId": "dummy-userid",
      "customPlatform": "instagram",
      "entityId": "dummt-entityid"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "userId": "dummy-userid",
  "newUser": false,
  "error": "User already exists"
}

Refresh user token

This endpoint refreshes the user token for a specified entity and user.

POSThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/refresh-token

Path parameters

entityId*string

userId*string

Query parameters

Header parameters

Body

refreshTokenstring

Example: "refresh-token-value"

Response

Successful response

Body

successboolean

Example: true

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/refresh-token?userId=dummy-userid', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "token": "new-access-token"
  }
}

Update user details

This endpoint allows the user to update their details.

POSThttps://api.questprotocol.xyz/api/users/{userId}

Path parameters

userId*string

Header parameters

Body

The request body.

namestring

Example: "Jon Doe"

imageUrlstring

Example: "https://www.myimage.com"

bannerUrlstring

Example: "https://www.mybanner.com"

locationstring

Example: "India"

expertisearray of string

goalsarray of string

interestsarray of string

aboutstring

Example: "Jon is a passionate software developer with several years of experience in building web applications."

currentWorkstring

Example: "Software engineer at XYZ Tech"

funFactsstring

Example: "Once climbed Mount Kilimanjaro and has performed at local music festivals with my band."

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Get user details

This endpoint retrieves the details of a specific user.

GEThttps://api.questprotocol.xyz/api/users/{userId}

Path parameters

userId*string

Header parameters

Response

Successful response

Body

successboolean

dataUser (object)

isAdminboolean

Example: false

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "userId": "12345",
    "userRecordMappingId": "67890",
    "signatureToken": "abc123",
    "name": "John Doe",
    "username": "johndoe",
    "imageUrl": "https://example.com/profile.jpg",
    "bannerUrl": "https://example.com/banner.jpg",
    "subtitle": "Software Engineer",
    "location": "New York, USA",
    "interests": [
      "Blockchain",
      "AI",
      "Gaming"
    ],
    "expertise": [
      "Web Development",
      "Data Science"
    ],
    "goals": [
      "Learn new technologies",
      "Contribute to open-source projects"
    ],
    "eth_nfts": [
      {
        "nftId": "nft1",
        "nftName": "NFT 1",
        "nftImageUrl": "https://example.com/nft1.jpg",
        "nftContractId": "ethcontract1"
      },
      {
        "nftId": "nft2",
        "nftName": "NFT 2",
        "nftImageUrl": "https://example.com/nft2.jpg",
        "nftContractId": "ethcontract2"
      }
    ],
    "polygon_nfts": [
      {
        "nftId": "nft3",
        "nftName": "NFT 3",
        "nftImageUrl": "https://example.com/nft3.jpg",
        "nftContractId": "polygoncontract1"
      }
    ],
    "sol_nfts": [
      {
        "nftId": "nft4",
        "nftName": "NFT 4",
        "nftImageUrl": "https://example.com/nft4.jpg",
        "nftContractId": "solcontract1"
      }
    ],
    "about": "I'm a passionate developer interested in blockchain and artificial intelligence.",
    "currentWork": "Acme Corporation",
    "role": "Other",
    "funFacts": [
      "I love hiking",
      "I play guitar"
    ],
    "tokenGeneratedAt": "2023-06-27T10:15:00Z",
    "lastHardRefreshAt": "2023-06-26T18:30:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z"
  },
  "isAdmin": false
}

Get user details for email

This endpoint retrieves the details of a specific user by their email.

GEThttps://api.questprotocol.xyz/api/users/email/{email}

Path parameters

email*string

Header parameters

Response

Successful response

Body

successboolean

dataUser (object)

isAdminboolean

Example: false

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/email/{email}', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid"
    },
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "userId": "12345",
    "userRecordMappingId": "67890",
    "signatureToken": "abc123",
    "name": "John Doe",
    "username": "johndoe",
    "imageUrl": "https://example.com/profile.jpg",
    "bannerUrl": "https://example.com/banner.jpg",
    "subtitle": "Software Engineer",
    "location": "New York, USA",
    "interests": [
      "Blockchain",
      "AI",
      "Gaming"
    ],
    "expertise": [
      "Web Development",
      "Data Science"
    ],
    "goals": [
      "Learn new technologies",
      "Contribute to open-source projects"
    ],
    "eth_nfts": [
      {
        "nftId": "nft1",
        "nftName": "NFT 1",
        "nftImageUrl": "https://example.com/nft1.jpg",
        "nftContractId": "ethcontract1"
      },
      {
        "nftId": "nft2",
        "nftName": "NFT 2",
        "nftImageUrl": "https://example.com/nft2.jpg",
        "nftContractId": "ethcontract2"
      }
    ],
    "polygon_nfts": [
      {
        "nftId": "nft3",
        "nftName": "NFT 3",
        "nftImageUrl": "https://example.com/nft3.jpg",
        "nftContractId": "polygoncontract1"
      }
    ],
    "sol_nfts": [
      {
        "nftId": "nft4",
        "nftName": "NFT 4",
        "nftImageUrl": "https://example.com/nft4.jpg",
        "nftContractId": "solcontract1"
      }
    ],
    "about": "I'm a passionate developer interested in blockchain and artificial intelligence.",
    "currentWork": "Acme Corporation",
    "role": "Other",
    "funFacts": [
      "I love hiking",
      "I play guitar"
    ],
    "tokenGeneratedAt": "2023-06-27T10:15:00Z",
    "lastHardRefreshAt": "2023-06-26T18:30:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z"
  },
  "isAdmin": false
}

Get user details for wallet address

This endpoint retrieves the details of a specific user by their wallet address.

GEThttps://api.questprotocol.xyz/api/users/address/{walletAddress}

Path parameters

walletAddress*string

Header parameters

Response

Successful response

Body

successboolean

dataUser (object)

isAdminboolean

Example: false

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/address/{walletAddress}', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid"
    },
});
const data = await response.json();

Response

{
  "success": false,
  "data": {
    "userId": "12345",
    "userRecordMappingId": "67890",
    "signatureToken": "abc123",
    "name": "John Doe",
    "username": "johndoe",
    "imageUrl": "https://example.com/profile.jpg",
    "bannerUrl": "https://example.com/banner.jpg",
    "subtitle": "Software Engineer",
    "location": "New York, USA",
    "interests": [
      "Blockchain",
      "AI",
      "Gaming"
    ],
    "expertise": [
      "Web Development",
      "Data Science"
    ],
    "goals": [
      "Learn new technologies",
      "Contribute to open-source projects"
    ],
    "eth_nfts": [
      {
        "nftId": "nft1",
        "nftName": "NFT 1",
        "nftImageUrl": "https://example.com/nft1.jpg",
        "nftContractId": "ethcontract1"
      },
      {
        "nftId": "nft2",
        "nftName": "NFT 2",
        "nftImageUrl": "https://example.com/nft2.jpg",
        "nftContractId": "ethcontract2"
      }
    ],
    "polygon_nfts": [
      {
        "nftId": "nft3",
        "nftName": "NFT 3",
        "nftImageUrl": "https://example.com/nft3.jpg",
        "nftContractId": "polygoncontract1"
      }
    ],
    "sol_nfts": [
      {
        "nftId": "nft4",
        "nftName": "NFT 4",
        "nftImageUrl": "https://example.com/nft4.jpg",
        "nftContractId": "solcontract1"
      }
    ],
    "about": "I'm a passionate developer interested in blockchain and artificial intelligence.",
    "currentWork": "Acme Corporation",
    "role": "Other",
    "funFacts": [
      "I love hiking",
      "I play guitar"
    ],
    "tokenGeneratedAt": "2023-06-27T10:15:00Z",
    "lastHardRefreshAt": "2023-06-26T18:30:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z"
  },
  "isAdmin": false
}

Get user's entities

This endpoint retrieves all the entities the user is part of.

GEThttps://api.questprotocol.xyz/api/users/{userId}/entities

Path parameters

userId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataarray of object

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}/entities', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "id": "e-0000001",
      "name": "some entity",
      "openseaSlug": "dummy-slug",
      "description": "this is the entity description",
      "twitter": "twitterusername",
      "discord": "discordusername",
      "telegram": "telegramusername",
      "instagram": "telegramusername",
      "website": "https://www.entitywebsite.com",
      "contracts": [
        "contractid"
      ],
      "ownerIDs": [
        "u-dummy-user"
      ],
      "imageUrl": "dummy-image-url",
      "bannerUrl": "dummy-banner-url"
    }
  ]
}

Get user's admin entities

This endpoint retrieves all the entities the user is an admin of.

GEThttps://api.questprotocol.xyz/api/users/{userId}/admin-entities

Path parameters

userId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataarray of object

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}/admin-entities', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": [
    {
      "name": "entity-name",
      "description": "entity-name",
      "id": "entity-id",
      "imageUrl": "dummy-image-url"
    }
  ]
}

Select current admin entity

This endpoint updates the current admin entity of the user.

POSThttps://api.questprotocol.xyz/api/users/{userId}/admin-entities

Path parameters

userId*string

Header parameters

Body

The request body.

entityIdstring

Example: "e-exampleEnittyId"

Response

Successful response

Body

successboolean

Example: true

Request

const response = await fetch('https://api.questprotocol.xyz/api/users/{userId}/admin-entities', {
    method: 'POST',
    headers: {
      "apikey": "test",
      "token": "dummy-token",
      "userid": "dummy-userid",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": true
}

Get user's connected socials

This endpoint retrieves all the socials the user is connected to.

GEThttps://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/connected-socials

Path parameters

entityId*string

userId*string

Header parameters

Response

Successful response

Body

successboolean

Example: true

dataobject

Request

const response = await fetch('https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/connected-socials', {
    method: 'GET',
    headers: {
      "apikey": "test",
      "userid": "dummy-userid",
      "token": "dummy-token"
    },
});
const data = await response.json();

Response

{
  "success": true,
  "data": {
    "ethAddresses": [
      "eth-address"
    ],
    "emails": [
      "[email protected]"
    ],
    "twitter": {
      "name": "your name",
      "username": "twitter user name",
      "userId": "userId"
    },
    "discord": {
      "name": "your name",
      "username": "discord user name",
      "userId": "userId"
    }
  }
}

PreviousQuest SDKs & APIs NextEntity

Last updated 10 months ago

Wallet login

Send login OTP

Verify login OTP

Google login

login using external source

Create new custom user.

Refresh user token

Update user details

Get user details

Get user details for email

Get user details for wallet address

Get user's entities

Get user's admin entities

Select current admin entity

Get user's connected socials

Refresh user token

Send login OTP

Wallet login

Google login

Verify login OTP

Select current admin entity

Create new custom user.

Get user's entities

login using external source

Update user details

Get user details for wallet address

Get user details

Get user's admin entities

Get user's connected socials

Get user details for email