Resources

Jump to Listing Management objectsListing Management objects

In this article, you can review the detailed descriptions of the objects used in Listing Management API.

Jump to Location objectLocation object

Parameters

location_id

Unique identifier for this location.

Output only.

Value/Type: string

business_name

Official public name of the business.

Max. length is 125 characters.

Value/Type: string

phone_number

Primary contact phone number for the business.

International format is required. For example: "+49 351 8629318", "+1 541-754-3010"

Value/Type: string

country

Two-letter country code where the business is located, as defined by the ISO 3166-1 code reference (the Alpha-2 code column).

Supported values: US, AU, FR, DE, GB, CA, IN, ES, IT, NL, BR, AT, BE, DK, FI, NO, PL, SE, CH, JP, MX, IL, NZ, SG, ZA, TR, AE, HK, ID, VN, PK, CO, IE, BD, MY, SA, RO, CL, PH, PT, NG, GR, TH, AR, PE, KE, HU, CZ, RS, NP, LT, UA, BG, EC, CY, HR, EE, LV, IS, SK, SI, AM, AD, PY, GY, EG, MV, UY, SR, KH, BO, LA, MT, PA, PR, TN, DO, MN, GU, VE, ME, MP The list of supported countries will increase in the future.

Value/Type: string

region

Highest administrative subdivision for postal addresses in a country or region. For example, a state, province, oblast, or prefecture. Specifically, for Spain this is the province rather than the autonomous community (for example, "Barcelona" instead of "Catalonia"). Many countries do not use administrative areas in postal addresses.

Required for Canada, Australia, Brazil, India, and US.

Value/Type: string

city

City or locality name.

Max. length is 64 characters.

Value/Type: string

zip

Postal or ZIP code.

Required for the following countries: US, AU, FR, DE, GB, CA, IN, ES, IT, NL, BR, AT, BE, DK, FI, NO, PL, SE, CH, JP, MX, IL, NZ, SG, ZA, TR, ID, VN, PK, CO, IE, BD, MY, SA, RO, CL, PH, PT, NG, GR, TH, AR, PE, KE, HU, CZ, RS, NP, LT, UA, BG, EC, CY, HR, EE, LV, IS, SK, SI, AM, AD, PY, EG, MV, UY, KH, LA, MT, PA, PR, TN, DO, MN, GU, VE, ME, MP

Value/Type: string

address_line_1

Street address, including house number and street name.

Max. length is 190 characters.

Value/Type: string

address_line_2

Supplemental address information (for example, suite, floor, or building).

Max. length is 64 characters.

Value/Type: string

website_url

URL for the business. Must start with https://. If possible, use a URL specific to this location rather than a generic brand website.

Max. length is 255 characters.

Value/Type: string

description

Detailed description of the business and its services.

Min. length is 10 characters. Max. length is 750 characters.

Value/Type: string

business_hours

The Business Hours object.

Value/Type: object

special_hours

List of Special Hours objects.

Value/Type: array of objects

more_hours

List of More Hours objects.

Value/Type: array of objects

service_area_places

List of Service Area Place objects.

Value/Type: array of objects

category_ids

List of category identifiers (max. 10) that describe the business and help customers find relevant services.

Identifiers must be retrieved from the Get Categories endpoint.

Value/Type: array of strings

suppress_address

If set to true, the physical address is hidden from public listings and search results. If the address is hidden, service_area_places must be populated to define the business’s geographic reach.

Value/Type: boolean

coordinates

The Coordinates object.

Value/Type: object

featured_message

Promotional message or announcement displayed on the business profile.

Max. length is 50 characters.

Value/Type: string

featured_message_url

Call-to-action URL associated with the featured message.

Example: "https://www.semrush.com/local-business/start/"

Max. length is 255 characters.

Value/Type: string

youtube_video

URL of a YouTube video showcasing the business.

Example: "https://www.youtube.com/watch?v=ndJB4J951_k"

Max. length is 150 characters.

Value/Type: string

instagram_username

Instagram profile handle.

Example: semrush

Max. length is 30 characters.

Value/Type: string

twitter_username

X (formerly Twitter) profile handle.

Example: semrush

Max. length is 15 characters.

Value/Type: string

reopen_date

Date ("YYYY-MM-DD") when a temporarily closed location is scheduled to reopen. This must be a future date and is only applicable if the location status is set to temporarily closed.

Value/Type: string

payment_options

Supported payment methods for the business.

Identifiers must be retrieved from the Get Payment Options endpoint.

Value/Type: array of strings

location_status

Supported values: "COMPLETED", "PROCESSING", "FAILED".

Current status of the location.

COMPLETED: Location is ready for use. All features and data management are fully accessible. PROCESSING: Location is currently being initialized. Data editing is unavailable until the process completes. FAILED: Location could not be created. This status does not consume user limits. You may delete the location and create a new location using your existing limit. Contact Semrush Customer Support if the issue persists.

Output only.

Value/Type: string

frozen

If true, the location is frozen due to an overdue payment. A frozen location cannot be edited, and management actions cannot be performed on its associated resources (such as images, listings, etc.).

Output only.

Value/Type: boolean

submit_date

Date and time when the location was first submitted in the "YYYY-MM-DDThh:mm:ss" format (for example, "2026-03-10T17:03:42").

Output only.

Value/Type: string

errors

List of Error objects.

Output only.

Value/Type: array of objects

Jump to Business Hours objectBusiness Hours object

Parameters

monday_hours

List of Hour Range objects for Monday.

Value/Type: array of objects

tuesday_hours

List of Hour Range objects for Tuesday.

Value/Type: array of objects

wednesday_hours

List of Hour Range objects for Wednesday.

Value/Type: array of objects

thursday_hours

List of Hour Range objects for Thursday.

Value/Type: array of objects

friday_hours

List of Hour Range objects for Friday.

Value/Type: array of objects

saturday_hours

List of Hour Range objects for Saturday.

Value/Type: array of objects

sunday_hours

List of Hour Range objects for Sunday.

Value/Type: array of objects

Jump to Hour Range objectHour Range object

Parameters

from

Start of the interval in the "HH:MM" format (for example, "09:00").

Value/Type: string

to

End of the interval in the "HH:MM" format (for example, "20:00").

Value/Type: string

Jump to Special Hours objectSpecial Hours object

Parameters

type

Supported values: "CLOSED", "OPENED_ALL_DAY", "RANGE".

If the value is "RANGE", the times parameter must be specified.

If the value is "CLOSED" or "OPENED_ALL_DAY", the times parameter must not be specified.

Value/Type: string

day

Date of the specified item. Must be in the "yyyy-mm-dd" format.

The value must be unique across all special_hours entries—only one item is allowed for each date.

Value/Type: string

times

List of Hour Range objects. Must be specified only for type = "RANGE". The time ranges of the specified day (or consecutive specified days) can’t overlap.

Value/Type: array of objects

Jump to More Hours objectMore Hours object

Parameters

type

Type of hours. Valid values must be retrieved from the Get More Hour Types endpoint.

Value/Type: string

hours

Weekly operating schedule for this hour type. An empty list implies the location is closed. The Business Hours object.

Value/Type: object

Jump to Service Area Place objectService Area Place object

Parameters

name

Human-readable name of the area (for example, "Manhattan"). Max. length is 80 characters.

Value/Type: string

place_id

Unique identifier for the location (Google Place ID).

Get the Google Place ID from the Google Maps Platform documentation.

Max. length is 500 characters.

Value/Type: string

Jump to Coordinates objectCoordinates object

Parameters

latitude

Latitude in decimal degrees (for example, 40.7128).

Min. value is -90, max. value is 90.

Value/Type: double

longitude

Longitude in decimal degrees (for example, -74.0060).

Min. value is -180, max. value is 180.

Value/Type: double

Jump to Error objectError object

Parameters

code

Unique, machine-readable string identifying the error type (for example, "INVALID_ZIP_CODE").

Value/Type: string

message

Human-readable explanation of the error to help with debugging.

Value/Type: string

Jump to Image objectImage object

Parameters

id

Unique identifier for the image.

Value/Type: string

type

Image category. Possible values: PHOTO, PROFILE, COVER.

Value/Type: string

url

Public URL where the image can be accessed or downloaded.

Value/Type: string

description

Caption describing the image content.

Value/Type: string

create_date

Timestamp when the image was created, in the ISO 8601 format (YYYY-MM-DDThh:mm:ss).

Value/Type: string

Jump to Listing objectListing object

Parameters

id

Unique identifier of the listing across all listing platforms.

Value/Type: string

status

Current connection status of the listing.

Supported values: CONNECTED, SUBMITTED, UNAVAILABLE, DISCONNECTED, PROCESSING.

Value/Type: string

name

Display name of the listing platform (for example, "Apple Maps", "Google Business Profile").

Value/Type: string

controllable

Indicates if the listing can be toggled (enabled or disabled) by the user.

Value/Type: boolean

url

Public URL of the business profile on the listing platform.

Value/Type: string

parent_id

Identifier of the parent listing, if this listing belongs to a hierarchy. Disabling a parent listing typically affects all its child listings.

Value/Type: string

Jump to Category objectCategory object

Parameters

id

Unique identifier for this category.

Value/Type: string

name

Primary display name of the category.

Value/Type: string

full_name

Full hierarchical path of the category (for example, "Books > Comic book store").

Value/Type: string

parent_id

Identifier of the parent category. Returns null for top-level categories.

Value/Type: string

Last updated: June 2, 2026

Was this page helpful?