Entities
Endpoints
List All Entities
The paginated API is used to query for multiple entities. You can apply filters through the query parameter to search for specific entities.
Endpoint
GET
Query Parameters
| Name | Description | Required | Example |
|---|---|---|---|
| page |
The number of the page that will be returned.
|
No | 1 |
| limit |
The number of resources per page.
|
No | 100 |
| offset |
The number of resources to be skipped.
|
No | |
| orderBy |
The column by which the resources will be sorted.
|
No | |
| id |
The entity id to be retrieved.
|
No | |
| address |
The address for which entities are to be retrieved.
|
No | |
| publicKey |
The public key for which entities are to be retrieved.
|
No | |
| isResigned |
The flag to indicate that resigned entities should be retrieved.
|
No | |
| type |
The type of entities to be retrieved.
|
No | |
| subType |
The sub-type of entities to be retrieved.
|
No | |
| data.name |
The name of the entities to be retrieved.
|
No | |
| data.ipfsData |
The IPFS Hash of the entities to be retrieved.
|
No |
| Name | page |
| Description |
The number of the page that will be returned.
|
| Required | No |
| Example | 1 |
| Name | limit |
| Description |
The number of resources per page.
|
| Required | No |
| Example | 100 |
| Name | offset |
| Description |
The number of resources to be skipped.
|
| Required | No |
| Example |
| Name | orderBy |
| Description |
The column by which the resources will be sorted.
|
| Required | No |
| Example |
| Name | id |
| Description |
The entity id to be retrieved.
|
| Required | No |
| Example |
| Name | address |
| Description |
The address for which entities are to be retrieved.
|
| Required | No |
| Example |
| Name | publicKey |
| Description |
The public key for which entities are to be retrieved.
|
| Required | No |
| Example |
| Name | isResigned |
| Description |
The flag to indicate that resigned entities should be retrieved.
|
| Required | No |
| Example |
| Name | type |
| Description |
The type of entities to be retrieved.
|
| Required | No |
| Example |
| Name | subType |
| Description |
The sub-type of entities to be retrieved.
|
| Required | No |
| Example |
| Name | data.name |
| Description |
The name of the entities to be retrieved.
|
| Required | No |
| Example |
| Name | data.ipfsData |
| Description |
The IPFS Hash of the entities to be retrieved.
|
| Required | No |
| Example |
Retrieve an Entity
Specific entities can be retrieved by the ID of their registration transaction.
Endpoint
GET
Path Parameters
| Name | Description | Required | Example |
|---|---|---|---|
| id |
The identifier of the registration transaction of the entity to be retrieved.
|
No |
| Name | id |
| Description |
The identifier of the registration transaction of the entity to be retrieved.
|
| Required | No |
| Example |
Last updated 4 years ago
Edit Page