Overview
You can use this request to retrieve a list of the available field definitions.
The Method
| API | Method | Endpoint |
|---|---|---|
| REST | GET | https://[Your URL]/api/2.0/definitions |
| XML-RPC | Call | definitions.ListDefinitions |
Example Request
{
"links":[
{
"title":"Self",
"rel":"self",
"href":"https:\/\/live.everlytic.net\/api\/2.0\/definitions"
},
{
"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"
},
{
"title": "Home",
"rel": "home",
"href": "https://live.everlytic.net/api/2.0/"
}
],
"collection": {
"Contacts": {
"href": "https://live.everlytic.net/api/2.0/definitions/contacts",
"data": {
"name": "contacts"
}
},
"Lists": {
"href": "https://live.everlytic.net/api/2.0/definitions/lists",
"data": {
"name": "lists"
}
},
"Emails": {
"href": "https://live.everlytic.net/api/2.0/definitions/emails",
"data": {
"name": "emails"
}
},
"TransactionalMails": {
"href": "https://live.everlytic.net/api/2.0/definitions/transaction_sender",
"data": {
"name": "transaction_sender"
}
},
"TransactionalGroups": {
"href": "https://live.everlytic.net/api/2.0/definitions/transaction_groups",
"data": {
"name": "transaction_groups"
}
},
"TransactionalSettings": {
"href": "https://live.everlytic.net/api/2.0/definitions/transaction_settings",
"data": {
"name": "transaction_settings"
}
}
}
}