Getting Started

Campaigns

Inventory

Zones

Management

Analytics

Folders

Get a list of Folders

get

/folders

Query Parameters

limit int	The number of items returned in the response. Defaults to 100.
offset int	The number of items to skip before starting to return results. Defaults to 0.

Example Request

curl "https://{yourname}.api.adglare.app/v2/folders"
-H "Authorization: Bearer {api_key}"

Example Response

{
    "items": [{
        "folder_id": 643068557,
        "parent_id": 0,
        "created": 764685530,
        "name": "My Folder",
        "level": "campaigns",
        "count": 27
    },
    {
        "folder_id": 847284728,
        "parent_id": 0,
        "created": 764685530,
        "name": "Another Folder",
        "level": "campaigns",
        "count": 45
    }]
}

Get a single Folder

get

/folders/{id}

Path Parameters

int, required

The ID of the folder.

Example Request

curl "https://{yourname}.api.adglare.app/v2/folders/{id}"
-H "Authorization: Bearer {api_key}"

Example Response

{
    "folder_id": 643068557,
    "parent_id": 0,
    "created": 764685530,
    "name": "My Folder",
    "level": "campaigns",
    "count": 27
}

Create a Folder

post

/folders

Request Body (JSON)

name string, required	The name of the folder.
workspace_id int	The workspace ID of the folder. Defaults to 0.

Example Request

curl "https://{yourname}.api.adglare.app/v2/folders"
  -X POST
  -H "Content-Type: application/json"
  -H "Authorization: Bearer {api_key}"
  -d '{
    "name": "My Folder",
    "workspace_id": 123456789
  }'

Example Response

{
"folder_id": 643068557
}

Update a Folder

put

/folders/{id}

Path Parameters

int, required

The ID of the folder.

Request Body (JSON)

name

string, required

The name of the folder.

Example Request

curl "https://{yourname}.api.adglare.app/v2/folders/{id}"
  -X PUT
  -H "Content-Type: application/json"
  -H "Authorization: Bearer {api_key}"
  -d '{
    "name": "My Folder"
  }'

Example Response

{}

Delete a Folder

delete

/folders/{id}

Path Parameters

int, required

The ID of the folder.

Example Request

curl "https://{yourname}.api.adglare.app/v2/folders/{id}"
-X DELETE
-H "Authorization: Bearer {api_key}"

Example Response

{}