GET /crm/v3/objects/tickets/{ticketId}

Read an Object identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.

Servers

Path parameters

Name Type Required Description
ticketId String Yes

Query parameters

Name Type Required Description
archived Boolean No

Whether to return only results that have been archived.

Default value: false

properties[] Array No

A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.

associations[] Array No

A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.

idProperty String No

The name of a property whose values are unique for this object type

propertiesWithHistory[] Array No

A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.