V4MOS.AI API
GuidesAPI Referenceapp.v4mos.ai
Facebook Ads

Creatives

GET
/v1/facebook/creatives

Retrieve Facebook Ads creative assets data including creative configurations, media assets, and creative-level metadata.

This endpoint provides creative-level insights including object type, status, media URLs, and creative specifications.

Dimensions Available:

  • Creative ID, name, object type, status, ad ID, ad created time
  • Media: Instagram permalink URL, thumbnail URL, title, video ID, image URL
  • Configuration: URL tags, optimization type, ad formats (JSON), website link, call to action types (JSON), title text
  • Targeting: age range (min/max), publisher platforms (JSON)
  • Positions: Facebook, Instagram, Messenger, Audience Network configurations
  • Additional: page ID, Instagram user ID, story specifications

Limitations:

  • Maximum 5000 records per page
  • Supports date filtering via dateStart and dateEnd (ISO 8601 format)
  • Supports sorting via orderBy and orderDirection (ASC/DESC)

Filters:

  • organizationId (required)
  • userId (optional)
  • integrationName (optional)
  • dateStart (optional)
  • dateEnd (optional)

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

userId?string

User identifier (optional)

integrationName?string

Integration name identifier (optional)

dateStart?string

Start date for filtering (optional, ISO 8601 format)

Formatdate
dateEnd?string

End date for filtering (optional, ISO 8601 format)

Formatdate
page?integer

Page number for pagination (optional)

Default1
limit?integer

Number of items per page (optional, max 5000)

Rangevalue <= 5000
Default500
orderBy?string

Field to order by (optional)

orderDirection?string

Order direction (optional)

Value in"ASC""DESC"

Response Body

Successful response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/facebook/creatives?organizationId=organization_123&dateStart=2024-01-01&dateEnd=2024-12-31"
{  "data": [    {      "creative_id": "string",      "creative_name": "string",      "object_type": "string",      "status": "string",      "ad_id": "string",      "ad_created_time": "2019-08-24T14:15:22Z",      "instagram_permalink_url": "string",      "thumbnail_url": "string",      "title": "string",      "video_id": "string",      "image_url": "string",      "url_tags": "string",      "optimization_type": "string",      "ad_formats": {},      "website_link": "string",      "call_to_action_types": {},      "title_text": "string",      "age_max": 0,      "age_min": 0,      "publisher_platforms": {},      "facebook_positions": {},      "instagram_positions": {},      "messenger_positions": {},      "audience_network_positions": {},      "reasons_to_shop": "string",      "shops_bundle": "string",      "page_id": "string",      "instagram_user_id": "string",      "story_spec_link": "string",      "story_spec_link_name": "string",      "organization_id": "string",      "user_id": "string",      "document_id": "string",      "integration_name": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}

Regions GET

Previous Page

Ad Set Config GET

Next Page