Skip to main content
GET
Get a session

Authorizations

Authorization
string
header
required

A Parley API key.

Path Parameters

id
string
required

The session ID.

Minimum string length: 1

Response

OK

id
string
required

The session ID.

Minimum string length: 1
title
string | null
required

The session's title, written by Parley after the first reply unless someone named it, or null until then.

status
enum<string>
required

working: Parley's assistant is working, a message is waiting for it, or it is waiting on subagents it started in the background. idle: the assistant has stopped and is waiting for the next message.

Available options:
working,
idle
origin
enum<string>
required

Where the session was started: web (Parley's web app, or an email to Parley's assistant), word or outlook (the add-in), automation (an automation run), or api (the REST API, MCP, or the CLI).

Available options:
web,
word,
outlook,
automation,
api
project
object | null
required

The project the session works in, with that project's files, notes, and linked records as its context, or null for a session across the organization.

automation
object | null
required

The automation whose run started the session, or null.

lastRun
object | null
required

The assistant's most recent pass over the session's messages, or null before it starts.

url
string<uri>
required

Where to open the session in Parley.

createdAt
string<date-time>
required

When the session was started.

updatedAt
string<date-time>
required

When the session last changed, such as by a new message.