Retrieve a Share Token

Retrieve the information for an existing Share Token.

Bearer authentication of the form Bearer <token>, where token is your auth token.

The ID of the Share Token

Determines casing for the API response.

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

Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the `included` key in the response. See [Serialization](https://docs.withpersona.com/serialization#inclusion-of-related-resources) for more details.

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.

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](https://docs.withpersona.com/serialization#sparse-fieldsets) for more details.

When true, the caller is the destination organization, and the destination organization has access to the source data peek capability, the response’s data.attributes.source-data carries a PII-filtered source-data envelope. Defaults to false; omitted from list responses regardless.

This endpoint returns a Share Token resource.

A Share Token resource. The specific attributes and relationships included may vary based on the requesting organization's context.

Excluded from the response by default. Will be an empty array when the include query parameter in the request was explicitly set to empty.

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

A comma-separated list of relationship paths. This can be used to customize which related resources will be fully serialized in the included key in the response. See Serialization for more details.

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.

1	{
2	"data": {
3	"type": "connect/share-token",
4	"id": "cnst_ABC123",
5	"attributes": {
6	"status": "redeemed",
7	"direction": "inbound",
8	"created-at": "2023-08-17T23:18:13.000Z",
9	"updated-at": "2023-08-17T23:30:15.000Z",
10	"pending-at": "2023-08-17T23:25:00.000Z",
11	"redeemed-at": "2023-08-17T23:30:15.000Z"
12	},
13	"relationships": {
14	"connection": {
15	"data": {
16	"type": "connect/connection",
17	"id": "cxn_ABC123"
18	}
19	},
20	"destination": {
21	"data": {
22	"type": "inquiry",
23	"id": "inq_XYZ789"
24	}
25	}
26	}
27	}
28	}

$	curl https://api.withpersona.com/api/v1/connect/share-tokens/share-token-id \
>	-H "Authorization: Bearer <token>"

Authentication

Path parameters

Headers

Query parameters

Response

Errors