Headers

• Authorization string

  Bearer token used for authorization

  Minimum length is 1.

• X-Correlation-Id string

  Unique identifier to allow referencing a particular transaction or event chain

  Minimum length is 1.

• Accept-Language string

  Returns the requested resources translated according to the passed languages (see translatable resources)

  Minimum length is 1.

Path parameters

• id string Required

  Primary identifier of the requested resource

  Minimum length is 1.

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data object Required
    Hide data attributes Show data attributes object

    • id string Required

      Minimum length is 1.

    • name object | null Required
      Hide name attributes Show name attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • description object | null Required
      Hide description attributes Show description attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • directions object | null Required
      Hide directions attributes Show directions attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • parkingInfo object | null Required
      Hide parkingInfo attributes Show parkingInfo attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • email string | null

      Minimum length is 1.

    • externalId string | null

      Minimum length is 1, maximum length is 255.

    • phoneNumber string | null

      Minimum length is 1.

    • active boolean Required
    • virtual boolean Required
    • timeZone string Required

      Minimum length is 1.

    • usesIndependentAgents boolean Required
    • employeeRelations array[object] Required
      Hide employeeRelations attributes Show employeeRelations attributes object

      • role string Required

        Values are AGENT or OFFICE_MANAGER.

      • employee object Required
        Hide employee attributes Show employee attributes object

        • id string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
    • createdAt string(date-time) Required

      Minimum length is 1.

    • updatedAt string(date-time) Required

      Minimum length is 1.

    • deletedAt string(date-time) | null Required

      Minimum length is 1.

    • location object Required
      Hide location attributes Show location attributes object

      • city object | null Required
        Hide city attributes Show city attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • state object | null Required
        Hide state attributes Show state attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • street1 object | null Required
        Hide street1 attributes Show street1 attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • street2 object | null Required
        Hide street2 attributes Show street2 attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • postalCode string | null

        Minimum length is 1.

      • countryCode string Required

        Minimum length is 2, maximum length is 2.

      • formattedAddress string Required

        Minimum length is 1.

      • geolocation object Required
        Hide geolocation attributes Show geolocation attributes object

        • latitude number Required

          Minimum value is -90, maximum value is 90.

        • longitude number Required

          Minimum value is -180, maximum value is 180.

        • Additional properties are NOT allowed
      • translations object Required
        Hide translations attributes Show translations attributes object

        • city array[object] Required

          At least 1 element.

          Hide city attributes Show city attributes object

          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required

            Minimum length is 1.

          • Additional properties are NOT allowed
        • state array[object]

          At least 0 elements.

          Hide state attributes Show state attributes object

          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required

            Minimum length is 1.

          • Additional properties are NOT allowed
        • street1 array[object] Required

          At least 1 element.

          Hide street1 attributes Show street1 attributes object

          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required

            Minimum length is 1.

          • Additional properties are NOT allowed
        • street2 array[object]

          At least 0 elements.

          Hide street2 attributes Show street2 attributes object

          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required

            Minimum length is 1.

          • Additional properties are NOT allowed
        • Additional properties are NOT allowed
    • Additional properties are NOT allowed
    • translations object Required
      Hide translations attributes Show translations attributes object

      • name array[object] Required

        At least 1 element.

        Hide name attributes Show name attributes object

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • description array[object]

        At least 0 elements.

        Hide description attributes Show description attributes object

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • directions array[object]

        At least 0 elements.

        Hide directions attributes Show directions attributes object

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • parkingInfo array[object]

        At least 0 elements.

        Hide parkingInfo attributes Show parkingInfo attributes object

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
  • Additional properties are NOT allowed
• 404 application/json

  Resource not found

  Hide response attribute Show response attribute object

  • errors array[object] Required

    At least 1 element.

    Hide errors attributes Show errors attributes object

    • message string Required

      Minimum length is 1.

    • code string Required

      Minimum length is 1.

    • type string Required

      Minimum length is 1.

    • statusCode string Required

      Minimum length is 1.

• 422 application/json

  Business validation failed

  • LOCATION_GEOCODING_FAILED
  • LOCATION_TIME_ZONE_RESOLUTION_FAILED

  See Error codes

  Hide response attribute Show response attribute object

  • errors array[object] Required

    At least 1 element.

    Hide errors attributes Show errors attributes object

    • message string Required

      Minimum length is 1.

    • code string Required

      Minimum length is 1.

    • type string Required

      Minimum length is 1.

    • statusCode string Required

      Minimum length is 1.

    • arguments object | null