# collection.getList **Note:** Requests must be made to ****. ## 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.getList*. If it is not specified, the request will return the error code "30 - Missing mandatory parameter". | | collectionStatus | string |

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

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

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

Unlisted flipbooks 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.

Note: If you do not specify a flipbook status, the API will return all flipbooks within the specified range, regardless of their types.

| | query | string | A search query to help narrow down search results. This could be a keyword or a phrase to search through the title and description of the flipbook. | | from | number |

The index of the starting record for the returned list. You can limit the number of results by specifying the index for the first record (parameter from) and the last record (parameter to).

By default, if you do not specify the from and to parameters, the API call returns the first 50 records.

Default: 0.

| | to | number |

The index of the last record for the returned list. You can limit the number of results by specifying the index for the first record (parameter from) and the last record (parameter to).

By default, if you do not specify the from and to parameters, the API call returns the first 50 records.

Default: 50.

| | orderBy | string |

The field after which the returned list will be ordered. Possible values are date\_published, date\_created and name.

Default: date\_published.

| | orderMode | string |

Specifies if the list will be ordered ascending or descending. Possible values are asc and desc.

Default: desc.

| | folder | string |

The folder path where flipbooks are stored in your account.

You can specify a folder structure up to 3 levels.

If the folder does not exists or there are no flipbooks in that folder you will receive 0 results.

| ## Response parameters | Name | Type | Description | | ---------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | collectionsCount | string |

The total number of flipbooks that match the request. This number does not take into consideration the limits specified at the API call.

For example, your request could match 100 flipbooks, but it returns only the ones within the limits specified by from and to parameters.

| | collections | object | An object containing the list of flipbooks returned that match the requested criteria. The parameters for each flipbook are described in [the list below](/api-reference/api-method-collection.getlist.md#collection-parameters). | ### Flipbook parameters | 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. | | 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. | | createdDate | date | The date when the flipbook was created (not necessarily published). | | directLink | string | The public link of the flipbook. | ## 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" %} 
# GET
curl -X GET \
     -G \
     https://api.flipsnack.com/v1/ \
     -d action=collection.getList \
     -d apiKey=<YOUR-API-KEY> \
     -d collectionStatus=public \
     -d from=0 \
     -d to=2 \
     -d signature=<YOUR-REQUEST-SIGNATURE>
{% endtab %} {% tab title="HTML" %} ```html
``` {% endtab %} {% endtabs %} ### Response {% tabs %} {% tab title="JSON" %} ```json { "code": 20, "status": "OK", "data": { "collectionsCount": "15", "collections": [ { "collectionHash": "d3m0h45h", "collectionTitle": "Lorem ipsum", "collectionStatus": "public", "publishDate": "2015-06-09 04:50:23", "createdDate": "2015-06-09 04:50:21", "coverImage": "https://files.flipsnack.net/collections/items/913699e80d28331517aee0afci188784/covers/page_1/thumb", "directLink": "https://www.flipsnack.com/user/lorem-ipsum.html" }, { "collectionHash": "fdnlg59t", "collectionTitle": "Official document", "collectionStatus": "public", "publishDate": "2015-06-09 01:42:39", "createdDate": "2015-06-09 01:42:37", "coverImage": "https://files.flipsnack.net/collections/items/0553278b2fd72f91d88224222i188776/covers/page_1/thumb", "directLink": "https://www.flipsnack.com/user/official-document.html" } ] } } ``` {% endtab %} {% endtabs %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developers.flipsnack.com/api-reference/api-method-collection.getlist.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.