User

User module apis

Wallet login

This endpoint allows user to login through any crypto wallet.

post

/users/wallet/login

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Body

entityIdstringrequired

Example: e-123

walletAddressstringrequired

Example: e-x012121212

signaturestringrequired

Example: e-x012121212-121212

tokenstringrequired

Example: token-used-for-signature

refreshTokenstring

Example: dumy-refresh-token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/wallet/login' \
  --header 'apikey: test' \
  --header 'Content-Type: application/json' \
  --data '{
    "entityId": "e-123",
    "walletAddress": "e-x012121212",
    "signature": "e-x012121212-121212",
    "token": "token-used-for-signature",
    "refreshToken": "dumy-refresh-token"
  }'

200

201

400

500

200

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

User already exists

Send login OTP

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

post

/users/email-login/send-otp

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Body

emailstringrequired

Example: [email protected]

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/email-login/send-otp' \
  --header 'apikey: test' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[email protected]"
  }'

200

400

500

200

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

Successful response

Verify login OTP

This endpoint verifies the login OTP sent via email.

post

/users/email-login/verify-otp

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Body

emailstringrequired

Example: dummy-email

otpnumberrequired

Example: 123456

entityIdstring

Example: dummt-entityid

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/email-login/verify-otp' \
  --header 'apikey: test' \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "dummy-email",
    "otp": 123456,
    "entityId": "dummt-entityid"
  }'

200

400

500

200

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

User already exists

Google login

This endpoint allows user to login through google.

post

/users/google/login

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Body

codestringrequired

Example: dummy-code

redirectUristringrequired

Example: https://redirect.com/google

entityIdstring

Example: dummt-entityid

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/google/login' \
  --header 'apikey: test' \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "dummy-code",
    "redirectUri": "https://redirect.com/google",
    "entityId": "dummt-entityid"
  }'

200

400

500

200

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

User already exists

login using external source

This endpoint allows user to login through any external source.

post

/users/external/login

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

entity-authentication-tokenstring

The authentication token to authorize requests on behalf of an entity.

Example: dummy-token

user-agentstringrequired

Body

entityIdstring

Example: e-123

externalUserIdstring

Example: example-x012121212

walletAddressstring

Example: abc@

emailstring

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/external/login?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'user-agent: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "entityId": "e-123",
    "externalUserId": "example-x012121212",
    "walletAddress": "abc@",
    "email": "text"
  }'

200

201

400

500

200

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

User created

Create new custom user.

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

post

/users/custom-ids

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

Body

customUserIdstringrequired

Example: dummy-userid

customPlatformstringrequired

Example: instagram

entityIdstringrequired

Example: dummt-entityid

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/custom-ids' \
  --header 'apikey: test' \
  --header 'Content-Type: application/json' \
  --data '{
    "customUserId": "dummy-userid",
    "customPlatform": "instagram",
    "entityId": "dummt-entityid"
  }'

200

201

400

500

200

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

User already exists

Refresh user token

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

post

/entities/{entityId}/users/{userId}/refresh-token

Path parameters

entityIdstringrequired

userIdstringrequired

Query parameters

userIdstringrequired

The Id of the user performing the request.

Example: dummy-userid

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

Body

refreshTokenstring

Example: refresh-token-value

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/refresh-token?userId=dummy-userid' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'Content-Type: application/json' \
  --data '{
    "refreshToken": "refresh-token-value"
  }'

200

400

500

200

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

Successful response

Update user details

This endpoint allows the user to update their details.

post

/users/{userId}

Path parameters

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Body

namestring

Example: Jon Doe

imageUrlstring

Example: https://www.myimage.com

bannerUrlstring

Example: https://www.mybanner.com

locationstring

Example: India

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.

expertisestring[]

Example: ["Java","CPP","JavaScript"]

goalsstring[]

Example: ["To become a senior software engineer","contribute to open-source projects"]

interestsstring[]

Example: ["Photography","traveling","reading"]

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/{userId}' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Jon Doe",
    "imageUrl": "https://www.myimage.com",
    "bannerUrl": "https://www.mybanner.com",
    "location": "India",
    "about": "Jon is a passionate software developer with several years of experience in building web applications.",
    "currentWork": "Software engineer at XYZ Tech",
    "funFacts": "Once climbed Mount Kilimanjaro and has performed at local music festivals with my band.",
    "expertise": [
      "Java",
      "CPP",
      "JavaScript"
    ],
    "goals": [
      "To become a senior software engineer",
      "contribute to open-source projects"
    ],
    "interests": [
      "Photography",
      "traveling",
      "reading"
    ]
  }'

200

400

401

500

200

{
  "success": true
}

Successful response

Get user details

This endpoint retrieves the details of a specific user.

get

/users/{userId}

Path parameters

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/users/{userId}' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "success": true,
  "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",
    "about": "I'm a passionate developer interested in blockchain and artificial intelligence.",
    "currentWork": "Acme Corporation",
    "role": "Other",
    "tokenGeneratedAt": "2023-06-27T10:15:00Z",
    "lastHardRefreshAt": "2023-06-26T18:30:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z",
    "interests": [
      "Blockchain",
      "AI",
      "Gaming"
    ],
    "expertise": [
      "Web Development",
      "Data Science"
    ],
    "goals": [
      "Learn new technologies",
      "Contribute to open-source projects"
    ],
    "funFacts": [
      "I love hiking",
      "I play guitar"
    ],
    "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"
      }
    ]
  },
  "isAdmin": false
}

Successful response

Get user details for email

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

get

/users/email/{email}

Path parameters

emailstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/users/email/{email}' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid'

200

400

401

500

200

{
  "success": true,
  "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",
    "about": "I'm a passionate developer interested in blockchain and artificial intelligence.",
    "currentWork": "Acme Corporation",
    "role": "Other",
    "tokenGeneratedAt": "2023-06-27T10:15:00Z",
    "lastHardRefreshAt": "2023-06-26T18:30:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z",
    "interests": [
      "Blockchain",
      "AI",
      "Gaming"
    ],
    "expertise": [
      "Web Development",
      "Data Science"
    ],
    "goals": [
      "Learn new technologies",
      "Contribute to open-source projects"
    ],
    "funFacts": [
      "I love hiking",
      "I play guitar"
    ],
    "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"
      }
    ]
  },
  "isAdmin": false
}

Successful response

Get user details for wallet address

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

get

/users/address/{walletAddress}

Path parameters

walletAddressstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/users/address/{walletAddress}' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid'

200

400

401

500

200

{
  "success": true,
  "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",
    "about": "I'm a passionate developer interested in blockchain and artificial intelligence.",
    "currentWork": "Acme Corporation",
    "role": "Other",
    "tokenGeneratedAt": "2023-06-27T10:15:00Z",
    "lastHardRefreshAt": "2023-06-26T18:30:00Z",
    "modifiedAt": "2023-06-27T12:45:00Z",
    "createdAt": "2023-06-25T09:00:00Z",
    "interests": [
      "Blockchain",
      "AI",
      "Gaming"
    ],
    "expertise": [
      "Web Development",
      "Data Science"
    ],
    "goals": [
      "Learn new technologies",
      "Contribute to open-source projects"
    ],
    "funFacts": [
      "I love hiking",
      "I play guitar"
    ],
    "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"
      }
    ]
  },
  "isAdmin": false
}

Successful response

Get user's entities

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

get

/users/{userId}/entities

Path parameters

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/users/{userId}/entities' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid'

200

400

401

500

200

{
  "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",
      "imageUrl": "dummy-image-url",
      "bannerUrl": "dummy-banner-url",
      "contracts": [
        "contractid"
      ],
      "ownerIDs": [
        "u-dummy-user"
      ]
    }
  ]
}

Successful response

Get user's admin entities

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

get

/users/{userId}/admin-entities

Path parameters

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/users/{userId}/admin-entities' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid'

200

400

401

500

200

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

Successful response

Select current admin entity

This endpoint updates the current admin entity of the user.

post

/users/{userId}/admin-entities

Path parameters

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

tokenstringrequired

The token for user authentication.

Example: dummy-token

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

Body

entityIdstring

Example: e-exampleEnittyId

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.questprotocol.xyz/api/users/{userId}/admin-entities' \
  --header 'apikey: test' \
  --header 'token: dummy-token' \
  --header 'userid: dummy-userid' \
  --header 'Content-Type: application/json' \
  --data '{
    "entityId": "e-exampleEnittyId"
  }'

200

401

500

200

{
  "success": true
}

Successful response

Get user's connected socials

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

get

/entities/{entityId}/users/{userId}/connected-socials

Path parameters

entityIdstringrequired

userIdstringrequired

Header parameters

apikeystringrequired

The API key for authentication

Example: test

apisecretstring

The secret key for authentication

Example: test-secret

useridstringrequired

The Id of the user performing the request.

Example: dummy-userid

tokenstringrequired

The token for user authentication.

Example: dummy-token

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.questprotocol.xyz/api/entities/{entityId}/users/{userId}/connected-socials' \
  --header 'apikey: test' \
  --header 'userid: dummy-userid' \
  --header 'token: dummy-token'

200

400

401

500

200

{
  "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"
    }
  }
}

Successful response