https://api.zoomcatalog.com/catalogs/all
Intended Use
If your ZOOMcatalogs and ZOOMcustom Catalogs have not been linked, we reccommend using the /catalogs/ endpoint. For more information about having your catalogs linked, please contact your ZOOMcatalog account representative.
Retrieve a list of all ZOOMcatalogs associated with your account. If your catalogs are linked, the resources will include links to the customizable versions of the catalogs. If your catalogs are linked and you pass the for_username parameter or a user_token, the links to customizable catalogs will be autologin_uris.
Return Types
catalogs_with_personalize
catalogs_without_personalize
error
Permitted HTTP Request Methods
GET
HTTP Request Headers
Required | Name | Value |
---|---|---|
Yes | Content-Type | "application/json" |
Yes | Authorization | <access_token> or <user_token> |
Parameters
Required | Name | Description | Location |
---|---|---|---|
No | for_username | <string> - unique identifier representing a user in your application | Query String |
No | version | ISO 3166-1 alpha-2 country code in lowercase(E.g. us or ca) | Query String |
No | lang | ISO 639-1 language code in lowercase(E.g. us-en or ca-fr) | Query String |
No | is_priced | true returns priced catalogs, false returns non-priced, null (default) returns all. | Query String |
Notes
Sending a <user_token>
in the Authorization header will produce the same result as sending an <access_token>
in conjunction with the for_username
parameter. Sending a request with an <access_token>
without the for_username
parameter is equivalent to issuing a request to /catalogs/.
Errors
Code | Description | Likely Cause |
---|---|---|
400 | The token is corrupted | Malformed user or access token |
400 | The provided access token does not contain the scope required | An access_token was used where a user_token should be used, or the user associated with the user_token does not have permission to access the resource |
401 | The token has expired | The access or user token is too old |
404 | Invalid CLIENT_ID, please contact the administrator | The provided resource id is malformed or invalid |