Ad Accounts

The AdsAccount Object

Properties

idstring

The Rutter generated unique ID of the ad account.

platform_idstring

The platform specific ID of the ad account.

parent_idstringnullable

The Rutter ID of the parent ad account.

namestringnullable

The name of the ad account.

created_atstringnullable

The ISO 8601 timestamp that the ad account was created.

updated_atstringnullable

The ISO 8601 timestamp that the ad account was last updated.

last_synced_atstring

The ISO 8601 timestamp when the ad account was last synced by Rutter.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints

GET

/ads/accounts

GET

/ads/accounts/:id

List Ad Accounts

GEThttps://production.rutterapi.com/versioned/ads/accounts

Request Parameters

access_tokenstringqueryRequired

The access token of the connection.

cursorstringqueryOptional

Used to paginate to the next batch of objects. Should be a copy of the next_cursor value from the previous response.

limitintegerqueryOptional

Used to limit the number of returned objects. Defaults to 50.

sortstringqueryOptional

Used to sort the response objects, e.g. last_synced_at ASC. If a value is provided but ASC or DESC is not, defaults to ASC. If omitted, defaults to updated_at DESC. Currently supports the updated_at and last_synced_at fields.

expandenumqueryOptional

Include platform specific data (includes additional fields not provided by the Rutter object).

Must beplatform_data.

last_synced_at_minintegerqueryOptional

Used to filter objects with a last_synced_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

updated_at_maxintegerqueryOptional

Used to filter objects with a updated_at value less than or equal to the supplied value. Should be a Unix time in milliseconds.

updated_at_minintegerqueryOptional

Used to filter objects with a updated_at value greater than or equal to the supplied value. Should be a Unix time in milliseconds.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

accountsarray

Show accounts attributes

next_cursorstringnullableOptional

connectionobject

Show connection attributes

Support by integration

Facebook
Google
TikTok

Example Response Body

JSON

1{
2  "accounts": [
3    {
4      "id": "00000000-0000-0000-0000-000000000000",
5      "platform_id": "12345678",
6      "parent_id": "00000000-0000-0000-0000-000000000000",
7      "name": "Ads Account",
8      "created_at": "2023-01-02T02:34:56.000Z",
9      "updated_at": "2023-01-02T02:34:56.000Z",
10      "last_synced_at": "2023-01-02T02:34:56.000Z",
11      "platform_data": {
12        "id": 123,
13        "data": "Varies by platform"
14      }
15    }
16  ],
17  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",
18  "connection": {
19    "id": "00000000-0000-0000-0000-000000000000",
20    "orgId": "00000000-0000-0000-0000-000000000000",
21    "platform": "NETSUITE"
22  }
23}

Fetch an Ad Account

GEThttps://production.rutterapi.com/versioned/ads/accounts/:id

Request Parameters

idstringpathRequired

The unique ID of the object.

access_tokenstringqueryRequired

The access token of the connection.

id_typeenumqueryOptional

Used to indicate the type of id that is supplied. Defaults to rutter. Not yet supported on Sage Intacct or Dynamics 365 Business Central yet.

One ofrutter or platform.

force_fetchenumqueryOptional

Used to force a response even if the underlying connection has not finished its initial sync.

One oftrue or false.

Response Body

accountobject

Show account attributes

connectionobject

Show connection attributes

Support by integration

Facebook
Google
TikTok

Example Response Body

JSON

1{
2  "account": {
3    "id": "00000000-0000-0000-0000-000000000000",
4    "platform_id": "12345678",
5    "parent_id": "00000000-0000-0000-0000-000000000000",
6    "name": "Ads Account",
7    "created_at": "2023-01-02T02:34:56.000Z",
8    "updated_at": "2023-01-02T02:34:56.000Z",
9    "last_synced_at": "2023-01-02T02:34:56.000Z",
10    "platform_data": {
11      "id": 123,
12      "data": "Varies by platform"
13    }
14  },
15  "connection": {
16    "id": "00000000-0000-0000-0000-000000000000",
17    "orgId": "00000000-0000-0000-0000-000000000000",
18    "platform": "NETSUITE"
19  }
20}

Have questions?

Contact support for personalized guidance.

Contact support