Get Conversation

This endpoint reads, page by page, the messages in the consumer's conversation with a business about a project. It returns messages from both sides (consumer and business) plus automatic messages from Yelp, each with the actions available to the consumer.

Without a cursor, the most recent messages are returned. Messages are ordered oldest first within each page. Use previous_cursor to get older messages and next_cursor to get newer ones. Provide at most one cursor per request.

Requires a consumer OAuth access token with the projects scope. The conversation must belong to the consumer who authorized your application.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Conversation ID, as returned by Get Project Conversations.

Query Params
string
^[a-z]{2,3}_[A-Z]{2}$

Locale code in the format of {language code}_{country code}. See the list of supported locales.

string

Opaque cursor from a previous response. Returns the next page of newer messages. Cannot be combined with previous_cursor.

string

Opaque cursor from a previous response. Returns the previous page of older messages. Cannot be combined with next_cursor.

integer
1 to 20
Defaults to 20

Maximum number of messages to return.

string

IANA timezone that times in messages and actions are shown in, e.g. America/Los_Angeles. Defaults to the business's timezone.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json