---
title: "Gets a single office by OfficeKey"
method: GET
path: "/odata/v1/Office/{OfficeKey}"
tags: ["Office"]
---

# Gets a single office by OfficeKey

`GET /odata/v1/Office/{OfficeKey}`

Both methods are valid and return the same result: a single Office entity identified by its unique OfficeKey.
The path-style is more intuitive and commonly used in RESTful APIs.
The function-style follows OData conventions and may be required in certain query contexts (e.g., when the key contains special characters or is not a simple numeric ID).

<b>Path-style access: </b>```/odata/v1/Office/{OfficeKey}```

<b>Example: </b>```/odata/v1/Office/49```

<b> Function-style access: </b>```/odata/v1/Office('{OfficeKey}')```

<b>Example: </b>```/odata/v1/Office('49')```

## Path parameters

- `OfficeKey` string, required

## Query parameters

- `$select` string

## Response `200`

OK (DDF.Core.Entities.Office object)

- DDFInfrastructureSwaggerExampleModelsODataSingleResponse1DDFCoreEntitiesOfficeDDFCoreVersion1000CultureNeutralPublicKeyTokenNull
  - `@odata.context` string, nullable
  - `OfficeKey` string, nullable — A unique identifier for this record from the immediate source. This is the string only key and used as an alternative to the OfficeKeyNumeric fields.
  - `OfficeMlsId` string, nullable — The local, well-known identifier. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.
  - `OfficeAORKey` string, nullable — A system unique identifier. This is the Board ID of the Office's Primary Board or Association of REALTORS.
  - `OfficeNationalAssociationId` string, nullable — The national association ID of the office. i.e. In Canada, this is the CREA Organization ID of the Office.
  - `FranchiseNationalAssociationId` string, nullable — The national association ID of the Franchisor. In Canada this would be the CREAID
  - `OfficeBrokerNationalAssociationId` string, nullable — The national association Id of the Brokerage Owner. In Canada this would be the CREAID
  - `OfficeAddress1` string, nullable — The street number, direction, name and suffix of the office.
  - `OfficeAddress2` string, nullable — The unit/suite number of the office.
  - `OfficeCity` string, nullable — The city of the office.
  - `OfficeFax` string, nullable — North American 10 digit fax numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.
  - `OfficeName` string, nullable — The legal name of the brokerage.
  - `OfficePhone` string, nullable — North American 10 digit phone numbers should be in the format of ###-###-#### (separated by hyphens). Other conventions should use the common local standard. International numbers should be preceded by a plus symbol.
  - `OfficePhoneExt` string, nullable — The extension of the given phone number (if applicable).
  - `OfficePostalCode` string, nullable — The postal code of the office.
  - `Media` DDFCoreEntitiesMedia[], nullable — A collection of the types of media fields available for this Office.
    - `MediaKey` string, nullable — A unique identifier for this record from the immediate source. This may be a number, or string that can include URI or other forms. This is the system you are connecting to and not necessarily the original source of the record.
    - `LongDescription` string, nullable — The full description of the object.
    - `MediaURL` string, nullable — The URI to the media file referenced by this record.
    - `ModificationTimestamp` string, Enum: DateTime, nullable — Date/time the record was last modified (in Zulu time (UTC)).
    - `Order` integer, nullable — The order in which the media object is displayed. Zero is the primary photo per RETS convention.
    - `PreferredPhotoYN` boolean, nullable — When set to true, the media record in question is the preferred photo. This will typically mean the photo to be shown when only one of the photos is to be displayed.
    - `ResourceRecordId` string, nullable — The well known identifier of the related record from the source resource.
    - `ResourceRecordKey` string, nullable — The primary key of the related record from the source resource.
    - `ResourceName` string, Enum: ResourceName, nullable — The resource or table of the listing or other record the media relates to. i.e. Property, Member, Office, etc.
    - `MediaCategory` string, Enum: MediaCategory, nullable — Category describing the , Photos, Documents, Video, Unbranded Virtual Tour, Branded Virtual Tour, Floor Plan, Logo
  - `OfficeSocialMedia` DDFCoreEntitiesSocialMedia[], nullable — A collection of the types of social media fields available for this office. The collection includes the type of system and other details pertinent about social media
    - `SocialMediaKey` string, nullable — The local, well-known identifier. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system.
    - `ResourceRecordKey` string, nullable — The primary key of the related record from the source resource. For example the ListingKey, MemberKey, OfficeKey, etc. This is a foreign key from the resource selected in the ResourceName field.
    - `SocialMediaType` string, Enum: SocialMediaType, nullable — The type of sites, blog, social media, the Member URL or ID is referring to. i.e. Website, FaceBook, LinkedIn, Twitter, Instagram, etc.
    - `ModificationTimestamp` string, date-time — The transactional timestamp automatically recorded by the MLS system representing the date/time the media record was last modified (in Zulu time (UTC)).
    - `ResourceName` unknown
    - `SocialMediaUrlOrId` string, nullable — The website URL or ID of social media site or account of the member.
  - `ModificationTimestamp` string, Enum: DateTime, nullable — Date/time the roster (member or office) record was last modified (in Zulu time (UTC)).
  - `OriginalEntryTimestamp` string, Enum: DateTime, nullable — Date/time the office record was originally input into the source system (in Zulu time (UTC)).
  - `OfficeType` string, Enum: OfficeType, nullable — The type of business conducted by the office. i.e. Real Estate, Appraiser, etc.
  - `OfficeStateOrProvince` string, Enum: StateOrProvince, nullable — The state or province in which the office is located.
  - `OfficeAOR` string, Enum: AOR, nullable — The Office's Board or Association of REALTORS.
  - `OfficeStatus` string, Enum: OfficeStatus, nullable — Is the office active, inactive or under disciplinary action.
  - `OfficeCountry` string, Enum: Country, nullable — The country in a postal address.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `500` — Internal Server Error

---

[API](https://skmtc.net/realtor/apis/realtor-ca-ddf-web-api-documentation.md) · [All operations](https://skmtc.net/realtor/apis/realtor-ca-ddf-web-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/realtor/realtor-ca-ddf-web-api-documentation/versions/17c9ffddac21/schema)