---
title: "All branches defined for a company"
method: GET
path: "/v3/diary/{shortName}/company/branches"
tags: ["CompanyController"]
---

# All branches defined for a company

`GET /v3/diary/{shortName}/company/branches`

## Request

- Base URL: `https://live-api.letmc.com`
- URL: `https://live-api.letmc.com/v3/diary/{shortName}/company/branches`
- Auth: none declared
- TypeScript: <https://skmtc.dev/letmc/apis/agentos-api-v3-diary-call-group/docs/v3/diary/:shortName/company/branches/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `shortName` string, required

## Query parameters

- `offset` integer, required
- `count` integer, required

## Response `200`

OK

- AdvertisingBranchModelResults: Holds results from a paged query returning BranchModel values
  - `Data` AdvertisingBranchModel[]: The resulting data returned from the paged query range
    - `OID` string: The unique Object ID (OID).
    - `ETag` string: A unique identifier defining the object and change revision.
    - `Name` string: The branch name.
    - `CompanyName` string: The relevant company name, if not the one specified on the branch then the one on company.
    - `Address1` string: Branch address line 1.
    - `Address2` string: Branch address line 2.
    - `Address3` string: Branch address line 3.
    - `Address4` string: Branch address line 4.
    - `Postcode` string: Branch address postcode.
    - `WebAddress` string: Branch web address.
    - `EMailAddress` string: Branch email address.
    - `LandPhone` string: Branch land phone number.
    - `FaxPhone` string: Branch fax phone number.
    - `County` string: County
  - `Count` integer: The total number of results available for all pages

---

[API](https://skmtc.dev/letmc/apis/agentos-api-v3-diary-call-group.md) - [All operations](https://skmtc.dev/letmc/apis/agentos-api-v3-diary-call-group/llms.txt) - [OpenAPI document](https://skmtc.dev/letmc/apis/agentos-api-v3-diary-call-group/revisions/9e518bf9a2f6?raw)