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

    holiday_id integer

    Filter items by the holiday_id field.

    limit integer

    Possible values: >= 1 and <= 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.

    Operators:

    Usage: eq:{value}

    deleted string

    Possible values: [exclude, include, only]

    Default value: exclude

    Filter items by deletion status.

    deleted_at date-time

    Filter items by the deleted_at field.

    Operators:

    Usage: eq:{value}

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

    The unique identifier of the resource

    created_at date-timerequired

    The date and time when the resource was created

    updated_at date-timerequired

    The date and time when the resource was last updated

    name stringrequired

    Possible values: <= 255 characters

    The location name

    default booleanrequired

    Is default location

    deleted_at date-time

    The date and time when the resource was deleted

  • ]

Loading...