Skip to main content
The App API lets you look up the apps registered in your project. Use it to find the app ID to send when you create a unit with the Ad Unit API, or to check which app a unit’s app refers to.
You can’t create, update, or delete apps with the API. Register and manage apps in the console. See Managing Apps.

Prerequisites

  • You need an API key with the app:read scope. You can’t select this scope in [Settings] > [Integrations] in the console. Ask Adrop, and we’ll issue you a key with the scope. You can get the Ad Unit API and Ad Product API scopes on the same key.
Call the API from your server only. Don’t put API keys in apps or web pages.

Basics


Endpoints

Paths are relative to the Base URL.

App Object

Settings such as the app key used to initialize the SDK aren’t included in the response.

List Apps

Returns the project’s apps one page at a time. The order is mostly the order they were registered, but older apps may be out of order. Don’t rely on the order. Use next to read the following pages.

Request

Requires the app:read scope.

Query Parameters

Request Example

Response Example

Returns 200 with items (the apps) and next (the cursor for the next page). If there’s no next, this is the last page.

Get an App

Returns one app.

Request

Requires the app:read scope.

Request Example

Response

Returns 200 with an app object.

Errors

  • 404 PROJECT_APP_NOT_FOUND: The app doesn’t exist or belongs to another project.

Error Handling

Error responses include statusCode. Errors whose errorCode in the table below isn’t - also include errorCode. Handle errors by errorCode, or by statusCode when there’s no errorCode. For request format errors (VALIDATION_FAILED), path in detail.errors[] shows where the problem is.