Skip to main content
GET
Retrieve a case

Authorizations

Authorization
string
header
required

Enter your API key in the format: sk_test_xxxxx or sk_live_xxxxx

Path Parameters

case_id
string
required

Case ID

Response

Case details

id
string<uuid>
required

Unique identifier for the resource

Example:

"123e4567-e89b-12d3-a456-426614174000"

object
enum<string>
required

Object type

Available options:
case
Example:

"case"

mode
enum<string>
required

Whether this resource was created with test or live credentials. Test and live data are fully isolated — a test resource never appears in live results and vice versa.

Available options:
test,
live
Example:

"live"

created_at
string<date-time>
required

ISO 8601 timestamp of when the resource was created

Example:

"2025-10-24T10:30:00Z"

updated_at
string<date-time>
required

ISO 8601 timestamp of when the resource was last updated

Example:

"2025-10-24T15:45:00Z"

metadata
object
required

Store up to 50 custom key-value pairs for application-specific data. Useful for storing references to external systems, feature flags, or other custom attributes.

Example:
parent_type
enum<string>
required

Type of the parent resource this case attaches to.

Available options:
filing,
verification,
business,
session
parent_id
string
required

ID of the parent resource (filing_id, verification_id, etc.).

Example:

"fil_1a2b3c"

kind
enum<string>
required

Typed kind of case. Each kind has its own request/response payload shape — see the request/response fields.

Available options:
missing_information,
ra_termination
status
enum<string>
required

Lifecycle status. needs_response means the partner must act; under_review means Palm is working on it. Both are open states. resolved and superseded are terminal.

Available options:
needs_response,
under_review,
resolved,
superseded
summary
string
required

One-line summary of the case.

Example:

"Additional information needed to complete your filing."

opened_at
string<date-time>
required

Timestamp the case was opened.

details
string

Markdown-formatted details about the case.

request
object

Typed request payload — what Palm is asking for. Shape varies by kind.

response
object

Typed response payload — what the partner submitted. Present once the partner has responded. Shape varies by kind.

due_at
string<date-time>

Timestamp by which the case is expected to be resolved.

resolved_at
string<date-time>

Timestamp the case was resolved or superseded.

resolution_reason
enum<string>

Why the case left an open state. Set when status is resolved or superseded.

Available options:
response_received,
no_response_needed,
parent_canceled,
parent_completed,
parent_failed