Skip to content
/
List messages for a suppo...

List messages for a support ticket

Request

List all messages in a support ticket conversation, ordered by position.

Access control follows the same rules as the parent support ticket:

  • User-scoped tokens: Can only access messages for tickets belonging to that user
  • Organization-scoped tokens: Can only access messages for tickets belonging to users in that organization
  • Tokens with access_all_areas: Can access messages for all tickets including those without a user
Security
oauth2(Required scopes: support:read)
Path
support_ticket_idstringtick[A-Z\d]{26}required

The ID of the specific support ticket to retrieve.

Example:tick01HN2NJ9NMRZBXT1H6FT9N7735
Query
message_typestring

Filter by message type (e.g., INITIAL_REQUEST, CUSTOMER_RESPONSE, HUMAN_AGENT_RESPONSE, AI_AGENT_RESPONSE)

message_type__instring

Filter by multiple message types (comma-separated)

positioninteger

Filter by message position in the conversation (0 is first message)

position__gteinteger

Filter for messages at or after this position

position__lteinteger

Filter for messages at or before this position

Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/support_tickets/tick01HN2NJ9NMRZBXT1H6FT9N7735/messages?message_type=string&message_type__in=string&position=0&position__gte=0&position__lte=0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a list of messages for the specified support ticket.

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600
Bodyapplication/json
Array [
idstringtmsg[A-Z0-9]{26}read-onlyrequired

Unique identifier for the message.

Example:"tmsgA1B2C3D4E5F6G7H8I9J0K1L2M3"
positionintegerread-onlyrequired

The position in the conversation history. 0 is the first message.

Example:0
message_typestring(Support Ticket Message Type)read-onlyrequired

The type of message in the ticket conversation.

Enum:"INITIAL_REQUEST""CUSTOMER_RESPONSE""HUMAN_AGENT_RESPONSE""AI_AGENT_RESPONSE"
Example:"INITIAL_REQUEST"
messagestringread-onlyrequired

The message from the agent or customer.

Example:"I am having trouble connecting my Tesla to the app."
message_cleanstring or nullread-only

A cleaned version of the message with all unnecessary text removed.

Example:"Having trouble connecting Tesla to app."
created_atstring, (date-time)read-onlyrequired

When the message was created in the support system.

Example:"2019-08-24T14:15:22Z"
]
Response
[
  {
    "id": "tmsgA1B2C3D4E5F6G7H8I9J0K1L2M3",
    "position": 0,
    "message_type": "INITIAL_REQUEST",
    "message": "I am having trouble connecting my Tesla to the app.",
    "message_clean": "Having trouble connecting Tesla to app.",
    "created_at": "2019-08-24T14:15:22Z"
  }
]