Get an office

GET /offices/{id}

Get an office by its ID

Headers

Path parameters

  • id string Required

    Primary identifier of the requested resource

    Minimum length is 1.

Responses

  • 200 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data object Required

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • id string Required

        Minimum length is 1.

      • name object | null Required

        Additional properties are NOT allowed.

        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
      • description object | null Required

        Additional properties are NOT allowed.

        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
      • directions object | null Required

        Additional properties are NOT allowed.

        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
      • parkingInfo object | null Required

        Additional properties are NOT allowed.

        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
      • 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
      • meetingRooms array[object] Required
        Hide meetingRooms attribute Show meetingRooms attribute object
        • id string Required

          Minimum length is 1.

      • employeeRelations array[object] Required
        Hide employeeRelations attributes Show employeeRelations attributes object
        • role string Required

          Values are AGENT or OFFICE_MANAGER.

        • employee object Required

          Additional properties are NOT allowed.

          Hide employee attribute Show employee attribute object
          • id string Required

            Minimum length is 1.

      • 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

        Additional properties are allowed.

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

          Additional properties are NOT allowed.

          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
        • state object | null Required

          Additional properties are NOT allowed.

          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
        • street1 object | null Required

          Additional properties are NOT allowed.

          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
        • street2 object | null Required

          Additional properties are NOT allowed.

          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
        • 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

          Additional properties are NOT allowed.

          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.

        • translations object Required

          Additional properties are NOT allowed.

          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.

          • 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.

          • 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.

          • 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.

      • translations object Required

        Additional properties are NOT allowed.

        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.

        • 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.

        • 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.

        • 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.

  • 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.

GET /offices/{id}
curl \
 -X GET https://api.development.pexipengage.com/enterprises/acme/offices/1234 \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *"
Response examples (200)
{
  "data": {
    "id": "123",
    "name": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "description": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "directions": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "parkingInfo": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "email": "john.doe@pexip.com",
    "externalId": "ABCD1234",
    "phoneNumber": "+32412345678",
    "active": true,
    "virtual": true,
    "timeZone": "Europe/Brussels",
    "usesIndependentAgents": true,
    "meetingRooms": [
      {
        "id": "123"
      }
    ],
    "employeeRelations": [
      {
        "role": "AGENT",
        "employee": {
          "id": "123"
        }
      }
    ],
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z",
    "location": {
      "city": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "state": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "street1": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "street2": {
        "language": "en",
        "value": "Lorem ipsum"
      },
      "postalCode": "9000",
      "countryCode": "BE",
      "formattedAddress": "string",
      "geolocation": {
        "latitude": 51.0479466,
        "longitude": 3.6912248
      },
      "translations": {
        "city": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "state": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street1": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ],
        "street2": [
          {
            "language": "en",
            "value": "Lorem ipsum"
          }
        ]
      }
    },
    "translations": {
      "name": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "description": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "directions": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ],
      "parkingInfo": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  }
}
Response examples (404)
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}