Presentations

Endpoints for managing presentations

Get all presentations

get

This endpoint retrieves all presentations.

Authorizations
x-api-keystringRequired
Query parameters
sort-fieldstringOptional

The field to sort by (default updated_at).

sort-directionstringOptional

The direction to sort (ASC or DESC, default DESC).

page-sizeintegerOptional

The number of presentations per page (default 20).

current-pageintegerOptional

The current page number (default 1).

item-countintegerOptional

The total number of items.

state-filterstringOptional

If provided, returns only presentations with this state.

contact-idstringOptional

If provided, returns only presentations for this contact_id.

Responses
200

A paginated list of presentations

application/json
rowsobject[]Optional
countintegerOptional
get
/api/v1/presentations

Get a presentation by ID

get

This endpoint retrieves a presentation by its exchange id.

Authorizations
x-api-keystringRequired
Path parameters
presentation_exchange_idstringRequired

The presentation exchange id of the presentation to retrieve.

Responses
200

Presentation record retrieved successfully

application/json
recordobjectOptional

The retrieved presentation record.

get
/api/v1/presentations/{presentation_exchange_id}

Remove PII from a presentation

post

This endpoint manually removes PII from a presentation record.

Authorizations
x-api-keystringRequired
Path parameters
presentation_exchange_idstringRequired

The presentation exchange ID.

Example: ed453b46-6d4b-4777-a5ca-e5693d45108e
Responses
200

PII removed successfully

application/json
messagestringOptionalExample: Presentation PII removed
post
/api/v1/presentations/{presentation_exchange_id}/pii

Last updated

Was this helpful?