Get Catalogs

Retrieve catalogs associated with a specific account. The endpoint joins account_catalogs with catalogs to return catalog metadata for the specified account.

GET /api/catalogs

cURL

cURL

curl --request GET \
  --url https://api.recoupable.com/api/catalogs \
  --header 'x-api-key: <api-key>'

200

{
  "status": "success",
  "catalogs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "error": "<string>"
}

The Catalogs API also supports POST for creating/linking catalogs and DELETE for unlinking catalogs. See the Create Catalogs and Delete Catalogs endpoints.

Authorizations

x-api-key · string · header · required

Your Recoup API key. Learn more.

Query Parameters

account_id · string<uuid> · required

The unique identifier of the account to query

Response

200

application/json

Catalogs retrieved successfully

Response containing catalogs data

status · enum<string>

Status of the request

Available options: success, error

catalogs · object[]

Array of catalog objects

Show child attributes

error · string

Error message (only present if status is 'error')