Documentation

  2. Home
  4. Docs
  6. Documentation
  8. Contacts APIs – V1
  10. API: Entity List

API: Entity List

The purpose of this API is to List entities.

Request

URL
https://your_account.modulus.biz/api/cnt/entity?token=YOUR_TOKEN
API Name
entity
Method
GET
Source
Third Party Server
Recipient
modulus® Server
Content Type
application/json

Query String Parameters

Parameter
Required
Type
Description
token
Yes
Text
Your authentication token.
page_number
No
Number
Which page to list default value is 1.
page_size
No
Number
Number of records per page value must be from 10 to 100 (if less than 10 use 10, if greater than 100 use 100) default value is 10.
load_options
No
Array
Possible values: address, contact.
filter
No
Object
Possible values: codes, type, tags
       

Responses

HTTP Status result title message object
Success Responses        
200 OK true Success Vacancies listed successfully. 
{
  "meta_data": {
    "record_count": 1,
    "page_count": 1,
    "page_size": 1,
    "page_number": 1,
  }
  "data": [{
    "entity": [
         "code": ,
         "name": ,
         "type":  
    ],
    "tags": [],
    "addresses": [
      [ 
        "label" : ,
        "country_code" :,
        "city" : ,
        "address" : ,
        "address_line_2" : ,
      ]
    ],
    "contacts": [
   [ 
      "type" : ,
      "label" :,
      "value" : 
    ] 
   ]
  }] 
}
Failure Responses        
500 Internal Server Error false Error Error message describe the problem.  

Example

Request 
curl --request GET 'https://your_account.modulus.biz/api/cnt/entity?token=YOUR_TOKEN&page_size=30&page_number=1'
200 OK 
{
"result": true,
"title": "Success",
"message": "Entities retrieved successfully.",
"object": {
"meta_data": {
"page_number": 1,
"page_size": 100,
"page_count": 3,
"record_count": 300
},
"data": [
{
"entity": {
"code": "01",
"name": "Mohamed Gamal",
"type": "Individual"
},
"tags": [
"Employee",
"Customer",
"Supplier",
"Organization",
"Lead"
]
},
{
"entity": {
"code": "1",
"name": "apientity553",
"type": "Individual"
},
"tags": [
"Customer",
"Lead"
]
},
{
"entity": {
"code": "10",
"name": "mo",
"type": "Individual"
},
"tags": [
"Customer",
"Supplier",
"Lead"
]
},
{
"entity": {
"code": "100",
"name": "Contract Company 3",
"type": "Organization"
},
"tags": [
"Customer",
"Supplier"
]
},
{
"entity": {
"code": "1001",
"name": "ابراهيم غزلاني",
"type": "Individual"
},
"tags": [
"Customer"
]
}
]
}
}