<- Snippets API

Snippets API

Retrieve snippet

GET

 /v2/sites/{site_id}/snippet

Retrieves your snippet from a Square Online site.

A site can contain snippets from multiple snippet applications, but you can retrieve only the snippet that was added by your application.

You can call ListSites to get the IDs of the sites that belong to a seller.

Note: Square Online APIs are publicly available as part of an early access program. For more information, see Early access program for Square Online APIs.

Permissions:ONLINE_STORE_SNIPPETS_READ
Try in API Explorer
Link to section

Path parameters

Example code

Link to section

site_id

string

Required

The ID of the site that contains the snippet.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

snippet

The retrieved snippet.