Entity Module

APIs related to a particular Organization.

Get Entity Info

This API will give you details about your Organization.

GET https://api.questprotocol.xyz/api/entities/{entityId}

Path Parameters

Name	Type	Description
entityId*	String

Query Parameters

Name	Type	Description
address*	String
signature	String

200: OK

{
    "success": true,
    "data": {
        "contracts": [],
        "ownerAddress": [
            "0x8500b66dd1c8b5d79d8a09f2b4df698374695e9e",
            "0x61b2d571cd6ce9fd1c9494b9f4f36429edf0e511"
        ],
        "isEnabled": true,
        "public": false,
        "defaultDyNftThemeId": "0",
        "id": "c-546bf8eb-6bde-48ec-bf28-c83abea93209",
        "name": "AntoO",
        "openseaSlug": "",
        "description": "This is test community for the SDK Development",
        "twitter": "https://twitter.com/quest__labs",
        "discord": "to be added",
        "telegram": "to be added",
        "instagram": "to be added",
        "website": "https://www.questprotocol.xyz/",
        "modifiedAt": "2022-09-16T22:38:13.090Z",
        "createdAt": "2022-09-16T22:38:13.090Z",
        "__v": 0,
        "bannerURL": "https://pin.questprotocol.xyz/ipfs/QmPduw4GqKigq7Ko4xCZi6rnLUmMXbgmDe4fn5TsKcWd5E",
        "communityURLAlias": "quest-dev-sdk",
        "imageURL": "https://pin.questprotocol.xyz/ipfs/QmYMDATohHkwQac3C7PHU5gd5iWVtmR2y6363aDAm8GeWW"
    }
}

Update Entity Info

Can only be called by the owners of the entity.

POST https://api.questprotocol.xyz/api/entities

Path Parameters

Name	Type	Description
entityID*	String
update	String

Query Parameters

Name	Type	Description
address*	String
signature*	String

Request Body

Name	Type	Description
name*	String
contracts	String
openseaSlug	String
description*	String
ownerAddresses*	Array
twitter*	String
discord*	String
telegram	String
instagram	String
website*	String
imageUrl*	String
bannerUrl
defaultDyNftThemeId	String
id	String

200: OK

{     "success": true }

For any other custom, fields contact Quest Admins.

Get Users in Entity

Get a list of all users of the entity.

GET https://api.questprotocol.xyz/api/entities/{entityId}/users

Path Parameters

Name	Type	Description
entityID	String
users	String

Query Parameters

Name	Type	Description
address*	String
signature*	String

200: OK

```json
{
    "success": true,
    "users": [
        {},
        {},
        {},
        {},
        {},
        {},
        {}
    ]
}
```

Manually Add User to Entity

In some cases, an entity is automatically created.

POST https://api.questprotocol.xyz/api/entities/{entityId}/force-add

Path Parameters

Name	Type	Description
entityID*	String
users*	String

Query Parameters

Name	Type	Description
address*	String
signature*	String

Request Body

Name	Type	Description
addresses*	Array
Chain*	String

200: OK

{
    "success": true
}