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.

Query parameters

• id array[string]

  ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• external-id array[string]

  External ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

• active boolean

  Status to be considered for filtering

• tag array[string]

  Tag(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

• offset string(positive-integer)

  Offset for the results to be returned

  Default value is 0.

• limit string(positive-integer)

  Limitation for the number of results to be returned

  Default value is 25.

• with-deleted boolean

  Includes deleted resources in the results

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data array[object] Required
    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
    • externalId string | null

      Minimum length is 1, maximum length is 255.

    • active boolean Required
    • tags array[string] Required

      Minimum length of each is 1.

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

      Additional properties are NOT allowed.

      Hide location attributes Show location attributes object | null

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

  • meta object Required

    Additional properties are NOT allowed.

    Hide meta attributes Show meta attributes object

    • offset integer Required

      Minimum value is 0. Default value is 0.

    • limit integer Required

      Minimum value is 0. Default value is 25.

    • totalCount integer Required

      Minimum value is 0.