> For the complete documentation index, see [llms.txt](https://developers.flipsnack.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.flipsnack.com/api-reference/api-method-collection.getcollection.md). # collection.getCollection **Note:** Requests must be made to ****. You can also use this method at regular time intervals to check if an uploaded document has finished converting. This could be done right after a [collection.create](/api-reference/api-method-collection.create.md) method call. If the document's status is either complete or failed, you can stop checking its status. ## Request parameters | Name | Type | Description | | ------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | apiKey (required) | string | The API key provided for your user. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". If the key is incorrect the request returns the error code "41 - Invalid credentials". | | signature (required) | string | The signature must be calculated by you and added to the request. See [How to sign a request](/how-to-sign-a-request.md) for more information.If the parameter is missing the request will return the error code "30 - Missing mandatory parameter". If the signature is incorrect the request will return the error code "44 - Invalid signature". | | action (required) | string | The API method that should be called. In this case the value should be *collection.getCollection*. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". | | collectionHash (required) | string | The hash of the flipbook you wish to update. If you do not specify a flipbook hash, then the request will return the error code "30 - Missing mandatory parameter". | ## Response parameters If the upload is successful, the API call returns information about the flipbook which was just created. | Name | Type | Description | | --------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | collectionHash | string | The hash for the newly created flipbook. If the flipbook status is *editable* the generated hash will be temporary. Once the flipbook is published, a new, final hash will be generated for it. | | collectionTitle | string | The title of the flipbook. | | collectionDescription | string | The description of the flipbook. It can be specified in the creation parameters or generated by the conversion system. | | collectionStatus | string |

Possible values are:

While in processing:

Publishing a flipbook may take a few seconds. You can check the collectionStatus at regular intervals (e.g., every few seconds) using the collection.getCollection method. Continue making requests to collection.getCollection until the collectionStatus has a value other than processing.

| | coverImage | string | The url of the flipbook's thumbnail image. This thumbnail is generated from the first page of the first flipbook item. | | collectionPageCount | number | The number of pages in the flipbook, for all the flipbook items. | | createdDate | date | The date when the flipbook was created (not necessarily published). | | publishDate | date | The date when the flipbook was published. | | directLink | string | The public link of the flipbook. | | flipbookPageCount | number |

The number of pages of the flipbook item.

For flipbooks created with the API, collectionPageCount and flipbookPageCount should have the same value.

| | settings | object | An object containing the [configuration parameters](/api-reference/api-method-collection.create.md#configuration-parameters) of the flipbook, as set from the API call. [See the list below.](/api-reference/api-method-collection.create.md#configuration-parameters) | | collectionItems | array |

The list of flipbook items belonging to the flipbook. In case of flipbooks created using the API, the list contains a single item.

The parameters of the collection item are listed below.

| ### **Configuration parameters** | Name | Type | Description | | ---------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | collectionWidth | number | The embed width of the player (measured in pixels). | | collectionHeight | number | The embed height of the player (measured in pixels). | | collectionStatus | string |

The type of collection. Possible values are public, editable and unlisted.

Public collections are listed on your public profile and in search results. They are publicly available to other users.

Editable collections are not published. They must be published manually from the Flipsnack editor or updated using the collection.update method.

Unlisted collections are published but not listed on your profile page and in search results. Other users may view them only if they receive a direct link or an embedded player from you.

| | enableDownload | boolean | If set to *true*, displays the download button in the player menu. The menu is displayed only when the player is in fullscreen. | | enableFullScreen | boolean | If set to *true*, allows the player to enter fullscreen mode. | | enableSearch | boolean | If set to *true*, displays the search button in the player menu. If there is no text to search within the current collection item, the search button is displayed as disabled. | | tooltipsLanguage | string | Selects the language for the tooltips displayed in the player. Possible languages are: Basque, Bosanski, Català, Czech, Dansk, Deutsch, English, Español, כשר, Française, ελληνικά, Hrvatski, Indonesian, Italiano, Magyar, Nederlands, Nederlands, Norsk, Polski, Português, Português do Brasil, Română, Pусский, Cрпски, Slovene, Suomi, Slovak, Swedish, Turkish. | | transparentBackground | boolean | If set to *true*, the player is displayed with no background. | | backgroundColor | string | The background color of the player, specified as a hexadecimal value. If the **transparentBackground** is set to *true*, the player will ignore the **backgroundColor** parameter. | | autoFlip | boolean | If set to *true*, allows the player to automatically turn the pages of the flipbook. The pages turn after a time specified by the **autoFlipDelay** parameter. | | autoFlipDelay | number | Specifies the time in seconds for pages to turn automatically. If **autoFlip** is *false*, this parameter is ignored. | | rightToLeftOrientation | boolean | If set to *true*, allows the flipbook to be viewed from right to left: the first page is starts from the end as viewed in normal mode. This option is useful for documents written in right to left languages. | | singlePageView | boolean | If set to *true*, allows the flipbook to be viewed a single page at a time. | | logoUrl (DEPRECATED) | string | *This parameter is deprecated and will no longer return valid values, if any.* | | shareFacebook (DEPRECATED) | boolean | *This parameter is deprecated and will no longer return valid values, if any.* | | shareTwitter (DEPRECATED) | boolean | *This parameter is deprecated and will no longer return valid values, if any.* | | shareGooglePlus (DEPRECATED) | boolean | *This parameter is deprecated and will no longer return valid values, if any.* | | sharePinterest (DEPRECATED) | boolean | *This parameter is deprecated and will no longer return valid values, if any.* | | shareEmail (DEPRECATED) | boolean | *This parameter is deprecated and will no longer return valid values, if any.* | | shareLinkText (DEPRECATED) | string | *This parameter is deprecated and will no longer return valid values, if any.* | ### **Flipbook item parameters** | Name | Type | Description | | ------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | flipbookHash | string | The hash generated for the flipbook item. | | flipbookPageCount | number | The number of pages of the flipbook item. | | flipbookTitle | string | The title of the flipbook. | | flipbookDescription | string | The description of the flipbook. | | extension | string | The extension of the document that the flipbook is based on. Extensions can be pdf, jpg or png. | | convertStatus | string | The status of the flipbook specifies if it has finished converting or if it is still in the process of conversion. Possible values are *PROCESSING*, *FAILED* and *COMPLETE*. | ## Error codes For complete list of error codes and messages go to [API status codes](/api-status-codes.md) section. ## Examples ### Request {% tabs %} {% tab title="cURL" %} ```bash # GET curl -X GET \ -G \ https://api.flipsnack.com/v1/ \ -d action=collection.getCollection \ -d apiKey= \ -d collectionHash=d3m0h45h \ -d signature= ``` {% endtab %} {% tab title="HTML" %} ```html
``` {% endtab %} {% endtabs %} ### Response {% tabs %} {% tab title="JSON" %} ```json { "code": 20, "status": "OK", "data": { "collectionHash": "d3m0h45h", "collectionTitle": "Lorem ipsum", "collectionStatus": "published", "coverImage": "https://cdn.flipsnack.com/collections/items/7c5e600d4459fe4e04d23ae5ei188777/covers/page_1/medium", "directLink": "https://www.flipsnack.com/user/lorem-ipsum-d3m0h45h.html", "createdDate": "2015-06-09 01:43:05", "publishDate": "2015-06-09 01:43:07", "collectionPageCount": 2, "collectionItems": [ { "flipbookHash": "7c5e600d4459fe4e04d23ae5ei188777", "flipbookPageCount": "2", "flipbookTitle": "Lorem ipsum", "flipbookDescription": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.", "extension": "pdf", "convertStatus": "COMPLETE" } ], "settings": { "collectionWidth": "640", "collectionHeight": "385", "enableFullScreen": "true" } } } ``` {% endtab %} {% endtabs %}