Retrieving List of Fold Placements


Before using PubMatic APIs, first generate the API Token. For more information, refer to  Getting Started with PubMatic APIs


This API allows you to retrieve the list of all the fold placements present in the PubMatic system.




Request Headers


Header NameTypeValueRequiredDescription
AuthorizationStringBearer ${access_token}Yes

Need to send the access token generating for authentication at the place of ${access_token}.

For more information about access tokens, refer to Getting Started with PubMatic APIs.

Request Query Parameters


Parameter NameTypeRequiredDescription

Page number to be fetched in case of multiple pages.
Its default value is 1.


Maximum number of rows to be included in the response.
Its default value is 100.


Response Headers


Response Header NameType

Response Body


Response Body ParameterTypeDescription
metaDataObjectPagination details
idIntegerUnique identifier of the fold placement.
nameStringName of the fold placement.

Sample Response JSON

    "metaData": {
        "startIndex": 1,
        "request": {
            "pageSize": 3,
           "pageNumber": 1
        "totalRecords": 4,
        "endIndex": 3
    "items": [
            "id": 0,
            "name": "Unknown"
            "id": 1,
            "name": "Above the Fold"
            "id": 2,
            "name": "Below the Fold"

Error Codes

Error codes specific to this API method.


Error CodeError Description
CC03_0001No records found
CC03_0004Resource not found

⇧ Top

⇧ Top

Do you have feedback on this document? Let us know: email us.

Table of Contents