Skip to main content

List locations

GET 
/api/locations

Required permissions:

  • settings.company: allows view of company locations.

Here the dedicated support page.

Request​

Query Parameters

    limit integer

    Possible values: <= 100

    Default value: 100

    The number of items to include in the response.

    offset integer

    Default value: 0

    The offset of the first returned item.

    updated_at date-time

    Filter items by the updated_at field. This is in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

    Examples:

    Filter items updated on a date.

    Example: 2024-01-01T20:00:00%2B02:00

Header Parameters

    Wethod-Company stringrequired

    The company you want to interact with

    Wethod-Version stringrequired

    The API version you want to use

Responses​

Returns the list of locations set for the company.

Schema

  • Array [

    • id integerrequired

    Possible values: >= 1

    created_at date-timerequired
    updated_at date-timerequired
    name stringrequired

    Possible values: <= 255 characters

    default booleanrequired

  • ]

Loading...