Organizations
An Organization represents an brand, partner or ad agency, creation happens via Snap Business Manager.
Attributes
Attribute | Description | Required | Possible Values |
---|---|---|---|
name | Organization name | R |
Create an Organization
The only way to set up an Organization is to sign up for a Business account with Snap Business Manager.
Get All Organizations
curl "https://adsapi.snapchat.com/v1/me/organizations" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "success",
"request_id": "57affee300ff0d91229fabb9710001737e616473617069736300016275696c642d35396264653638322d312d31312d3700010110",
"organizations": [
{
"sub_request_status": "success",
"organization": {
"id": "40d6719b-da09-410b-9185-0cc9c0dfed1d",
"updated_at": "2017-05-26T15:14:44.877Z",
"created_at": "2017-05-26T15:14:44.877Z",
"name": "My Organization",
"address_line_1": "101 Stewart St",
"locality": "Seattle",
"administrative_district_level_1": "WA",
"country": "US",
"postal_code": "98134",
"type": "ENTERPRISE"
}
},
{
"sub_request_status": "success",
"organization": {
"id": "507d7a57-94de-4239-8a74-e93c00ca53e6",
"updated_at": "2016-08-01T15:14:44.877Z",
"created_at": "2017-08-01T15:14:44.877Z",
"name": "Hooli",
"address_line_1": "1100 Silicon Vallety Rd",
"locality": "San Francisco",
"administrative_district_level_1": "CA",
"country": "US",
"postal_code": "94110",
"type": "ENTERPRISE"
}
}
]
}
This endpoint retrieves all organizations.
HTTP Request
GET https://adsapi.snapchat.com/v1/me/organizations
Get All Organizations with Ad Accounts
curl "https://adsapi.snapchat.com/v1/me/organizations?with_ad_accounts=true" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5b985a7300ff0b4b064df945b80001737e616473617069736300016275696c642d33346634346232622d312d3230302d320001011f",
"organizations": [
{
"sub_request_status": "SUCCESS",
"organization": {
"id": "40d6719b-da09-410b-9185-0cc9c0dfed1d",
"updated_at": "2018-09-04T16:27:01.066Z",
"created_at": "2016-08-09T17:12:49.707Z",
"name": "Hooli Inc",
"country": "US",
"postal_code": "90291",
"locality": "Venice",
"contact_name": "",
"contact_email": "",
"contact_phone": "",
"tax_type": "NONE",
"address_line_1": "64 Market St",
"administrative_district_level_1": "CA",
"accepted_term_version": "8",
"is_agency": true,
"configuration_settings": {
"notifications_enabled": true
},
"type": "ENTERPRISE",
"state": "ACTIVE",
"roles": ["member"],
"ad_accounts": [
{
"id": "8b8e40af-fc64-455d-925b-ca80f7af6914",
"updated_at": "2018-03-07T23:39:20.469Z",
"created_at": "2018-03-27T23:42:43.513Z",
"name": "Hooli Originals",
"type": "PARTNER",
"status": "ACTIVE",
"currency": "USD",
"timezone": "America/Los_Angeles",
"roles": ["reports"]
},
{
"id": "497979f0-ea17-4971-8288-054883f1caca",
"updated_at": "2017-01-04T22:58:38.179Z",
"created_at": "2018-09-07T14:41:36.002Z",
"name": "Pied piper Test Account",
"type": "PARTNER",
"status": "ACTIVE",
"currency": "USD",
"timezone": "America/Los_Angeles",
"roles": ["admin"]
},
{
"id": "22ada972-f2aa-4d06-a45a-a7a80f53ae34",
"updated_at": "2017-07-28T02:32:03.914Z",
"created_at": "2017-12-08T21:56:57.305Z",
"name": "Initech Corp",
"type": "PARTNER",
"status": "ACTIVE",
"currency": "USD",
"timezone": "America/Los_Angeles",
"roles": ["creative"]
}
],
"my_display_name": "Honey Badger",
"my_invited_email": "honey.badget@hooli.com",
"my_member_id": "8454ada6-cec8-4e97-a0a7-c0b262c4137b"
}
}
]
}
This endpoint retrieves all organizations the user has access to and the ad accounts beneath each of those organizations. The roles attribute holds shows the role that the user holds within the Ad Account in question, Ad Account roles are explain in the Roles section.
HTTP Request
GET https://adsapi.snapchat.com/v1/me/organizations?with_ad_accounts=true
Get a Specific Organization
curl "https://adsapi.snapchat.com/v1/organizations/40d6719b-da09-410b-9185-0cc9c0dfed1d" \
-H "Authorization: Bearer meowmeowmeow"
The above command returns JSON structured like this:
{
"request_status": "SUCCESS",
"request_id": "5928472c00ff04f7eaae709d770001737e7465616d6b6f363139000161646d616e616765722d61706",
"organizations": [
{
"sub_request_status": "SUCCESS",
"organization": {
"id": "40d6719b-da09-410b-9185-0cc9c0dfed1d",
"updated_at": "2017-05-26T15:14:44.877Z",
"created_at": "2017-05-26T15:14:44.877Z",
"name": "My Organization",
"address_line_1": "101 Stewart St",
"locality": "Seattle",
"administrative_district_level_1": "WA",
"country": "US",
"postal_code": "98134",
"type": "ENTERPRISE"
}
}
]
}
This endpoint retrieves a specific organization.
HTTP Request
GET https://adsapi.snapchat.com/v1/organizations/<ID>
URL Parameters
Parameter | Description |
---|---|
ID | The ID of the organization to retrieve |