Getting Started

Campaigns

Creatives

Inventory

Zones

Management

Analytics

Workspaces

Get a list of Workspaces

get

/workspaces

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/workspaces"
-H "Authorization: Bearer {api_key}"

Example Response

{
    "items": [{
        "workspace_id": 643068557,
        "name": "My Workspace"
    },
    {
        "workspace_id": 847284728,
        "name": "Another Workspace"
    }]
}

Get a single workspace

get

/workspaces/{id}

Path Parameters

int, required

The ID of the workspace.

Example Request

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

Example Response

{
"workspace_id": 643068557,
"name": "My Workspace"
}

Create a workspace

post

/workspaces

Request Body (JSON)

name

string, required

The name of the workspace.

Example Request

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

Example Response

{
"workspace_id": 643068557
}

Update a workspace

put

/workspaces/{id}

Path Parameters

int, required

The ID of the workspace.

Request Body (JSON)

name

string, required

The name of the workspace.

Example Request

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

Example Response

{}

Delete a workspace

delete

/workspaces/{id}

Path Parameters

int, required

The ID of the workspace.

Example Request

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

Example Response

{}