Skip to main content

Catsy API Endpoints

The Catsy API endpoints the iPaaS.com integration uses, plus authentication, request format, pagination, and rate limits.

See what the Catsy integration can do →

This article lists the Catsy REST API endpoints the iPaaS.com integration uses to synchronize product catalog data, along with how the API authenticates requests, formats data, paginates results, and enforces rate limits. For the complete Catsy API reference, see the Catsy API Documentation.

Authentication

Catsy uses Bearer Token authentication. Every request includes the Catsy API Token in the Authorization header. To create the token in Catsy, go to Administration > Users & Roles, add a role with API access, add a user under that role, and copy the API key. Enter this value as the API Key on the iPaaS.com subscription settings page.

Request Format

All requests and responses use application/json. Each request includes the following headers:

  • Content-Type: application/json

  • Accept: application/json

  • Authorization: Bearer {your API Token}

Pagination and Filtering

Product lists are retrieved from a filtered search endpoint that accepts an offset and a limit to page through results. Filters are expressed as one or more conditions, each with an attributeKey (the field to filter on), an operator (such as is, contains, starts with, or between), and a value. Multiple conditions are combined so that all must match.

Rate Limits

Catsy enforces rate limiting using a token-bucket model. Clients are allowed 2 requests per second, with a maximum burst of 10 requests; the allowance refills at 2 requests per second up to the 10-request limit. When the limit is exceeded, Catsy responds with 429 Too Many Requests. The integration reschedules work automatically when it encounters a rate-limit response, so no subscriber action is required. If you see rate-limit activity frequently, lower the API Throttle Limit on the subscription settings so the integration sends requests more slowly.

(Rate-limit and authentication details above are from the Catsy API Documentation, accessed July 2026.)

Categories and Collections

Used by the Add/Update Catsy Category TO iPaaS.com flow. Catsy categories and collections are both retrieved and transferred into iPaaS.com as categories.

Get Categories (GET)

GET [Base URL]/v4/categories/tree

Retrieves the Catsy category tree.

Get Category (GET)

GET [Base URL]/api/v3/categories/{id}

Retrieves a single Catsy category by its ID.

Get Collections (GET)

GET [Base URL]/v4/collections

Retrieves Catsy collections, which are transferred as categories.

Get Collection (GET)

GET [Base URL]/v4/collections/{id}

Retrieves a single Catsy collection by its ID.

Products and Variants

Used by the Add/Update Catsy Product TO iPaaS.com and Add/Update Catsy Product FROM iPaaS.com flows.

Get Products (POST)

POST [Base URL]/v4/products/filter?offset={offset}&limit={limit}

Retrieves a filtered, paginated list of products. Used when polling Catsy for new and changed products.

Get Product (GET)

GET [Base URL]/v4/products/{id}

Retrieves a single product by its ID.

Get Product Variants (GET)

GET [Base URL]/v4/products/{id}/variants

Retrieves the variants of a product.

Get Product Items (GET)

GET [Base URL]/api/v3/products/{id}/items

Retrieves the items (option values) of a product.

Create Product and Variants (POST)

POST [Base URL]/v4/products

Creates a product, including its variants, in Catsy.

Update Product (PUT)

PUT [Base URL]/v4/products/{id}/values

Updates an existing product in Catsy. Only mapped values are sent, so values that are not mapped are left unchanged.

Attributes and Tags

Supporting endpoints used while transferring products.

Get Attributes (GET)

GET [Base URL]/v3/attributes

Retrieves the available product attributes, used to validate custom field values before they are written to a product.

Get Tags (GET)

GET [Base URL]/v4/tags

Retrieves existing product tags.

Create Tag (POST)

POST [Base URL]/v4/tags

Creates a product tag that does not already exist.

Related Documents

External References

Did this answer your question?