List Account Integrations

Beta
GET/v1/settings/integrations

This endpoint is idempotent. Learn more

Returns a paginated list of account integrations for the target account.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of object

Resources in this page.

idstring

Account integration ID.

objectstringenumValues:account_integration

Resource type identifier.

namestring

Display name of the integration.

providerstringenumValues:stripeshippohubspot

Integration provider code.

  • stripe: Stripe payment processing.
  • shippo: Shippo shipping and label generation.
  • hubspot: HubSpot CRM.
statusstringenumValues:activeinactive

Lifecycle status of the integration.

Integrations are created active. Setting an integration to inactive keeps its stored credentials but stops it from being used (for example, the Stripe publishable key cannot be retrieved while the Stripe integration is inactive).

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Account Integrations