Ad creation: Ad account

This document describes how to use the Ad account APIs.

There are two types of ad account — Business ad account and Personal ad account. An advertiser or an agency running ads for the advertiser can create a Business ad account.

View list of ad accounts

Basic information

Method	URL	Authorization
GET	https://apis.moment.kakao.com/openapi/v4/adAccounts	Access token

Permission	Prerequisite	Kakao Login	User consent
Required	Register platforms Activate Kakao Login Switch to a Biz app	Required	-

This API enables you to retrieve a list of ad accounts. This API provides a maximum of 1,500 ad account information.

Send a GET request with the issued access token in the request header. If the request is successful, this API returns an array of each ad account's detailed information in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header

Name	Description	Required
Authorization	Authorization: Bearer ${ACCESS_TOKEN} Access token as a type of user authentication.	O

Query parameter

Name	Type	Description	Required
config	Array	Status of ad accounts to be retrieved. Pass the values of ON, OFF, andDEL in a comma-separate string. (Default: ON, OFF)	X

Response

Body

Name	Type	Description
content	AdAccount[]	List of ad account information.

AdAccount

Name	Type	Description
id	Long	Ad account's ID.
name	String	Ad account's name.
memberType	MemberType	Member type. Either MASTER (Master role) or MEMBER(Member role).
config	Config	Ad account's status.
businessAccount	BusinessAccount	Business Account Information. Not returned if there is no associated business account.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/adAccounts?config=ON,OFF,DEL" \
    -H "Authorization: Bearer ${ACCESS_TOKEN}"

Response

{
    "content": 
    [
        {
            "id": 1111,
            "name": "kakao_moment_ad_account1",
            "memberType": "MASTER",
            "config": "ON"
        },
        {
            "id": 1112,
            "name": "kakao_moment_ad_account2",
            "memberType": "MEMBER",
            "config": "OFF"
        }
    ]
}