Facebook Ads

Accounts

GET
/v1/facebook/accounts

Retrieve Facebook Ads accounts data including account status, balance, spending information, and configuration details.

This endpoint returns account-level metadata and financial information.

Dimensions Available:

  • Account ID
  • Internal ID
  • Account status
  • Amount spent
  • Balance
  • Creation time
  • Account name
  • Spend cap

Limitations:

  • Maximum 5000 records per page
  • Default page size: 500
  • Supports pagination

Filters:

  • organizationId (required)
  • userId (optional)
  • integrationName (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)

page?integer

Page number for pagination (optional)

Default1
limit?integer

Number of items per page (optional, max 5000)

Rangevalue <= 5000
Default500

Response Body

Successful response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/facebook/accounts?organizationId=organization_123"
{  "data": [    {      "id": "string",      "account_id": "string",      "account_status": "string",      "amount_spent": 0,      "balance": 0,      "created_time": "2019-08-24T14:15:22Z",      "name": "string",      "spend_cap": 0,      "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  }}