Get a share

GET/api/share/id/{shareId}

Returns a share's configuration by its ID after checking access to the shared resource.

Try it

Headers

Name	Type	Description
Authorizationrequired	string	Token returned by POST /api/auth/login, or an API key (`umami_…`) created under Settings → API keys (self-hosted only). `Bearer <token>`.
x-umami-share-contextrequired	string	Required context header when authenticating with a share token. `<api-key>`.
x-umami-share-tokenrequired	string	Signed token returned by a share endpoint. `<api-key>`.

Path parameters

Name	Type	Description
shareIdrequired	string	Identifier used to access a shared resource.

Responses

200The operation completed successfully.

Name	Type	Description
createdAtrequired	string	Date and time the record was created.
entityIdrequired	string	ID of the resource being shared.
idrequired	string	Unique identifier of the resource.
namerequired	string	Display name of the resource.
parametersrequired	anyOf	Configuration parameters for the resource.

shareTyperequired	number	Type of resource made available by the share.
slugrequired	string	URL slug used to access the resource.
updatedAtrequired	string	Date and time the record was last updated.

200 example

{
  "createdAt": "2024-01-15T09:30:00Z",
  "entityId": "string",
  "id": "string",
  "name": "string",
  "parameters": "string",
  "shareType": 0,
  "slug": "string",
  "updatedAt": "2024-01-15T09:30:00Z"
}

401Unauthorized.

Name	Type	Description
errorrequired	object	Error details returned when the operation fails.

401 example

{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized.",
    "status": 401
  }
}

Code samples

cURL

curl -X GET 'https://api.example.com/api/share/id/{shareId}' \
  -H 'Authorization: Bearer <token>' \
  -H 'x-umami-share-context: <api-key>' \
  -H 'x-umami-share-token: <api-key>'

PreviousDelete a share NextOpen a share by its slug