WIwithpersona
connect

List all Share Tokens

Changed on

Returns a list of your organization's Share Tokens. Results are returned in reverse chronological order, with the most recently created objects first.

get/connect/share-tokens

Request

  • Base URL
    https://api.withpersona.com/api/v1
  • URL
    https://api.withpersona.com/api/v1/connect/share-tokens
  • Auth
    HTTP bearer

Query parameters

afterstring

Object ID for pagination cursor

beforestring

Object ID for pagination cursor

sizenumber double

Limit on the number of objects returned

fieldsobject

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

connection-idstring

Filter Share Tokens by connect connection ID

statusstring

Filter Share Tokens by status. One of created, pending, redeemed, expired, or failed.

directionstring

Filter Share Tokens by direction. Defaults to returning both inbound and outbound. One of inbound or outbound.

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Response

This endpoint returns a collection of Share Token resources.

Changes

  • 0a3310d5046fRevision changes
    • breaking

      added subschema #1 subschema #5 subschema #6 subschema #7 to the /// response property oneOf list for the response status

    • info

      removed subschema #1 from the /// response property oneOf list for the response status

  • d4f59a96930cRevision changes
    • breaking

      added subschema #15 subschema #16 subschema #17 to the /// response property oneOf list for the response status