Getting an event by its ID

This method allows getting a particular event data by its ID.

Limitations
The method is available for all account users. The returned data depends on the user’s rights for the entity.

Data type header when the request is successful
Content-Type: application/hal+json

Data type header in case of an error
Content-Type: application/problem+json

Response parameters

The method returns an event object.

ParameterData typeDescription
idstringEvent ID
typestringEvent type
entity_idintID of the entity the event belongs to
entity_typestringType of the entity the event belongs to
created_byintID of the user who created the event
created_atintEvent creation date in the Unix Timestamp format
value_afterarrayAn array of the event changes.
value_beforearrayAn array of the event changes.
account_idintAccount ID where the event is located in

WITH parameters

ParameterDescription
contact_nameIf event belongs to a contact, you will receive the contact’s name as well as the ID in the response
lead_nameIf event belongs to a lead, you will receive the lead’s name as well as the ID in the response
company_nameIf event belongs to a company, you will receive the company’s name as well as the ID in the response
catalog_nameIf event belongs to a list element, you will receive the list’s name as well as the ID in the response
catalog_element_nameIf event belongs to a list element, you will receive the list’s name as well as the ID in the response
Language
Credentials
OAuth2
URL
Click Try It! to start a request and see the response here!