{"id":4410,"date":"2025-02-26T14:08:49","date_gmt":"2025-02-26T12:08:49","guid":{"rendered":"https:\/\/modulus.help\/kb\/?post_type=docs&p=4410"},"modified":"2025-02-26T14:14:27","modified_gmt":"2025-02-26T12:14:27","slug":"api-entity-list","status":"publish","type":"docs","link":"https:\/\/modulus.help\/kb\/docs\/documentation\/contacts-apis-v1\/api-entity-list\/","title":{"rendered":"API: Entity List"},"content":{"rendered":"\n

The purpose of this API is to List entities.<\/p>\n\n\n\n

Request<\/h4>\n\n\n\n\n\n\n\n\n\n\n
\n
URL<\/div>\n<\/th>\n
\n
https:\/\/your_account.modulus.biz\/api\/cnt\/entity?token=YOUR_TOKEN<\/div>\n<\/td>\n<\/tr>\n
\n
API Name<\/div>\n<\/th>\n
\n
entity<\/div>\n<\/td>\n<\/tr>\n
\n
Method<\/div>\n<\/th>\n
\n
GET<\/div>\n<\/td>\n<\/tr>\n
\n
Source<\/div>\n<\/th>\n
\n
Third Party Server<\/div>\n<\/td>\n<\/tr>\n
\n
Recipient<\/div>\n<\/th>\n
\n
modulus\u00ae Server<\/div>\n<\/td>\n<\/tr>\n
\n
Content Type<\/div>\n<\/th>\n
\n
application\/json<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n\n

Query String Parameters<\/h4>\n\n\n\n\n\n\n\n\n\n\n\n
\n
Parameter<\/div>\n<\/th>\n
\n
Required<\/div>\n<\/th>\n
\n
Type<\/div>\n<\/th>\n
\n
Description<\/div>\n<\/th>\n<\/tr>\n
\n
token<\/strong><\/div>\n<\/td>\n
\n
Yes<\/div>\n<\/td>\n
\n
Text<\/div>\n<\/td>\n
\n
Your authentication token.<\/div>\n<\/td>\n<\/tr>\n
\n
page_number<\/strong><\/div>\n<\/td>\n
\n
No<\/div>\n<\/td>\n
\n
Number<\/div>\n<\/td>\n
\n
Which page to list default value is 1.<\/div>\n<\/td>\n<\/tr>\n
\n
page_size<\/strong><\/div>\n<\/td>\n
\n
No<\/div>\n<\/td>\n
\n
Number<\/div>\n<\/td>\n
\n
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.<\/div>\n<\/td>\n<\/tr>\n
\n
\n
\n
load_options<\/strong><\/div>\n<\/div>\n<\/div>\n<\/td>\n
\n
No<\/div>\n<\/td>\n
\n
Array<\/div>\n<\/td>\n
\n
Possible values: address, contact.<\/div>\n<\/td>\n<\/tr>\n
\n
\n
\n
filter<\/div>\n<\/div>\n<\/div>\n<\/th>\n
\n
No<\/div>\n<\/td>\n
\n
Object<\/div>\n<\/td>\n
\n
\n
Possible values: codes, type, tags<\/div>\n<\/div>\n<\/td>\n<\/tr>\n
\u00a0<\/th>\n\u00a0<\/td>\n\u00a0<\/td>\n\u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Responses<\/h4>\n\n\n\n\n\n\n\n\n
HTTP Status<\/th>\nresult<\/th>\ntitle<\/th>\nmessage<\/th>\nobject<\/th>\n<\/tr>\n
Success Responses<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n<\/tr>\n
200 OK<\/td>\ntrue<\/td>\nSuccess<\/td>\nVacancies listed successfully.<\/td>\n\n
{\n  \"meta_data\": {\n    \"record_count\": 1,\n    \"page_count\": 1,\n    \"page_size\": 1,\n    \"page_number\": 1,\n  }\n  \"data\": [{\n    \"entity\": [
         \"code\": ,
         \"name\": ,
         \"type\":  
    ],\n    \"tags\": [],\n    \"addresses\": [
      [ 
        \"label\" : ,
        \"country_code\" :,
        \"city\" : ,
        \"address\" : ,
        \"address_line_2\" : ,
      ]
    ],\n    \"contacts\": [
   [ 
      \"type\" : ,
      \"label\" :,
      \"value\" : 
    ] 
   ]\n  }] \n}<\/code><\/pre>\n<\/td>\n<\/tr>\n
Failure Responses<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n\u00a0<\/th>\n<\/tr>\n
500 Internal Server Error<\/td>\nfalse<\/td>\nError<\/td>\nError message describe the problem.<\/td>\n\u00a0<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n

Example<\/h4>\n\n\n\n\n\n
Request<\/th>\n\n
curl --request GET 'https:\/\/your_account.modulus.biz\/api\/cnt\/entity?token=YOUR_TOKEN&page_size=30&page_number=1'\n<\/code><\/pre>\n<\/td>\n<\/tr>\n
200 OK<\/th>\n\n
{
\"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\": \"\u0627\u0628\u0631\u0627\u0647\u064a\u0645 \u063a\u0632\u0644\u0627\u0646\u064a\",
\"type\": \"Individual\"
},
\"tags\": [
\"Customer\"
]
}
]
}
}<\/code><\/pre>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>","protected":false},"featured_media":0,"parent":4335,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","doc_tag":[],"comment_count":0,"_links":{"self":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4410"}],"collection":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/types\/docs"}],"replies":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/comments?post=4410"}],"version-history":[{"count":8,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4410\/revisions"}],"predecessor-version":[{"id":4421,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4410\/revisions\/4421"}],"up":[{"embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/docs\/4335"}],"wp:attachment":[{"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/media?parent=4410"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/modulus.help\/kb\/wp-json\/wp\/v2\/doc_tag?post=4410"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}