Contents

Get a Creative

Fetches a creative by identifier.

URL

GET https://api.searchads.apple.com/api/v5/creatives/{creativeId}

Path Parameters

NameTypeDescription
creativeId Requiredint64

The unique identifier for a Creative.

Query Parameters

NameTypeDescription
includeDeletedCreativeSetAssets Optionalboolean

Include deleted assets in the response. By default deleted assets don’t return.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
CreativeResponse

If the call succeeds, the API returns the CreativeResponse object in the response payload with an HTTP status code of 200(OK). If unsuccessful, the HTTP status code indicates the error with details in the error message.

400Bad Request
Content-Type: application/json
ApiErrorResponse

An invalid query or missing required parameters.

401Unauthorized
Content-Type: application/json
ApiErrorResponse

An unauthenticated call fails to get the requested response.

403Forbidden
Content-Type: application/json
ApiErrorResponse

Insufficient rights to the resource.

404Not Found
Content-Type: application/json
ApiErrorResponse

The API can’t locate the resource.

429
Content-Type: application/json
ApiErrorResponse

The API calls exceed rate-limit thresholds. See the Rate Limits subsection of Calling the Apple Ads API.

500Internal Server Error
Content-Type: application/json
ApiErrorResponse

The Apple Ads server is temporarily down or unreachable. The request may be valid, but you need to retry it later.

Discussion

Use this endpoint to fetch details of a Creative using your creativeId in the resource path.

Payload example: Get a creative

See Also

Creative Endpoints