Get Branch Configurations

Description

Retrieves a list of branch configurations, including detailed information such as address, CNPJ, operating hours, and associated search terms.

🔑 Query Parameters

This endpoint does not require parameters.

📤 Response Structure

The response is an array of objects containing detailed information for each branch.

Field	Type	Description
`idBranch`	integer	Unique identifier for the branch.
`name`	string	Public name of the branch.
`internalName`	string	Internal name of the branch.
`cnpj`	string	CNPJ of the branch.
`address`	string	Address of the branch.
`neighborhood`	string	Neighborhood where the branch is located.
`telephone`	string	Phone number of the branch (can be `null`).
`number`	string	Address number of the branch.
`idState`	integer	Identifier of the state of the branch.
`state`	string	Full name of the state.
`stateShort`	string	State abbreviation.
`city`	string	City where the branch is located.
`complement`	string	Address complement (can be `null`).
`zipCode`	string	ZIP code of the branch.
`website`	string	Name of the website or reference associated with the branch.
`latitude`	float	Latitude for geographical location.
`longitude`	float	Longitude for geographical location.
`openingDate`	datetime	Opening date of the branch (can be `null`).
`businessHours`	array	List of objects with the operating hours of the branch (detailed below).
`searchTerms`	array	Search terms associated with the branch.

🧩 Structure of the `businessHours` Object

Field	Type	Description
`idHour`	integer	Unique identifier for the operating hour.
`idBranch`	integer	Identifier of the associated branch.
`weekDay`	string	Days of the week corresponding to the hour (e.g., `2,3,4,5,6`).
`hoursFrom`	datetime	Start time of operation (ISO 8601 format).
`hoursTo`	datetime	End time of operation (ISO 8601 format).
`flDeleted`	boolean	Indicates if the hour has been deleted.
`idTmp`	integer	Temporary field (can be `null`).
`creationDate`	datetime	Creation date of the hour record (ISO 8601 format).
`idEmployeeCreation`	integer	Identifier of the staff member who created the hour record.

Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string username:password

Example:

Authorization: Basic *****************

Responses

🟢200OK

application/json

Success

Body

Example

{
    "idBranch": 0,
    "name": "string",
    "internalName": "string",
    "cnpj": "string",
    "address": "string",
    "neighborhood": "string",
    "telephone": "string",
    "whatsapp": "string",
    "number": "string",
    "idState": 0,
    "state": "string",
    "stateShort": "string",
    "city": "string",
    "complement": "string",
    "zipCode": "string",
    "website": "string",
    "latitude": 0,
    "longitude": 0,
    "facebookUrl": "string",
    "replyEmail": "string",
    "marketingEmail": "string",
    "siteSlug": "string",
    "openingDate": "2019-08-24T14:15:22.123Z",
    "businessHours": [
        {
            "idHour": 0,
            "idBranch": 0,
            "weekDay": "string",
            "hoursFrom": "2019-08-24T14:15:22.123Z",
            "hoursTo": "2019-08-24T14:15:22.123Z",
            "flDeleted": true,
            "idTmp": 0,
            "creationDate": "2019-08-24T14:15:22.123Z",
            "idEmployeeCreation": 0
        }
    ],
    "searchTerms": [
        "string"
    ]
}

🟠400Bad Request

Get branch configurations

Get Branch Configurations

Description

🔑 Query Parameters

📤 Response Structure

🧩 Structure of the `businessHours` Object

Request

Request Code Samples

Responses

Get branch configurations

Get Branch Configurations#

Description#

🔑 Query Parameters#

📤 Response Structure#

🧩 Structure of the businessHours Object#

Request

Request Code Samples

Responses

Get Branch Configurations

Description

🔑 Query Parameters

📤 Response Structure

🧩 Structure of the `businessHours` Object