Overview
You can use this request to retrieve the definition for a specific object. Submit the name of the object and the system will return the field definitions.
The Method
| API | Method | Endpoint |
|---|---|---|
| REST | GET | https://[Your URL]/api/2.0/definitions/$name |
| XML-RPC | Call | definitions.GetDefinition |
Parameters
| Property | Type | Description | Default | Required | Read Only |
|---|---|---|---|---|---|
| $name | string | The name of the object definition you need to retrieve. | none | yes | no |
Note: – only these options may be used for $name – “contacts”,”lists””emails”,”transaction_sender”,”transaction_groups”,”transaction_settings”
Example Request
{
"links":[
{
"title":"Self",
"rel":"self",
"href":"https:\/\/live.everlytic.net\/api\/2.0\/definitions\/contacts"
},
{
"title":"Home",
"rel":"home",
"href":"https:\/\/live.everlytic.net\/api\/2.0\/"
}
],
"error":
{
"code":"09001",
"message":"Definitions Error Occured: Access Denied",
"additional":null
}
}
Example Response
{
"links": [
{
"title": "Self",
"rel": "self",
"href": "https://live.everlytic.net/api/2.0/definitions/contacts"
},
{
"title": "Home",
"rel": "home",
"href": "https://live.everlytic.net/api/2.0/"
},
{
"title": "ListDefinitions",
"rel": "collection",
"href": "https://live.everlytic.net/api/2.0/definitions"
}
],
"item": {
"id": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": null
},
"country_id": {
"type": "integer",
"required": false,
"readonly": false,
"values": null,
"default": 1
},
"city_id": {
"type": "integer",
"required": false,
"readonly": false,
"values": null,
"default": 1
},
"name": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"lastname": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"email": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"mobile": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"date_create": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": null
},
"date_modified": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": null
},
"status": {
"type": "string",
"required": false,
"readonly": false,
"values": [
"on",
"off",
"suppressed"
],
"default": "on"
},
"score": {
"type": "float",
"required": false,
"readonly": true,
"values": null,
"default": 2
},
"rating": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 2
},
"email_status": {
"type": "string",
"required": false,
"readonly": true,
"values": [
"none",
"bouncing",
"bounced",
"always send"
],
"default": "none"
},
"sms_status": {
"type": "string",
"required": false,
"readonly": true,
"values": [
"none",
"bouncing",
"bounced",
"always send"
],
"default": "none"
},
"email_bounce_hard_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"email_bounce_soft_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"block_bounce_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"sms_bounce_hard_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"sms_bounce_soft_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"sms_bounce_consecutive_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"complaints_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"forward_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": null
},
"invite_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"update_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"bounce_unidentified_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"autoresponder_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"email_message_ids": {
"type": "string",
"required": false,
"readonly": true,
"values": null,
"default": null
},
"sms_message_ids": {
"type": "string",
"required": false,
"readonly": true,
"values": null,
"default": null
},
"email_message_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"sms_message_count": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"message_reads": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"message_reads_inferred": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"message_reads_unique": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"message_link_clicks": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"message_link_clicks_unique": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"contact_attachment_downloads_unique": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"contact_attachment_downloads_total": {
"type": "integer",
"required": false,
"readonly": true,
"values": null,
"default": 0
},
"preferred_email_format": {
"type": "string",
"required": false,
"readonly": false,
"values": [
"html",
"text"
],
"default": "html"
},
"title": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"company_position": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"company_name": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"department": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"industry": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"address": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"address_2": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"city": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"country": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"state": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"zip": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"telephone_office": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"telephone_home": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"telephone_fax": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"date_of_birth": {
"type": "integer",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"birth_date": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"gender": {
"type": "string",
"required": false,
"readonly": false,
"values": [
"unknown",
"male",
"female"
],
"default": null
},
"marital_status": {
"type": "string",
"required": false,
"readonly": false,
"values": [
"unknown",
"single",
"married"
],
"default": null
},
"education_level": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"hash": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"unique_id": {
"type": "string",
"required": false,
"readonly": false,
"values": null,
"default": null
},
"cfv_username12:username": {
"type": "text",
"required": false,
"readonly": false,
"values": null,
"default": null
}
}
}