MYmyclickfunnels
Fulfillments::Location

List Locations

Changed on

List Locations

get/workspaces/{workspace_id}/fulfillments/locations

Request

Path parameters

workspace_idstring required

Query parameters

afterstring

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

per_pageinteger

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

sort_order'asc' | 'desc'

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

sort_property'id' | 'updated_at' | 'sort_order'

Sort property of a list response. The default is id and thus the created_at order. If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Response

OK

idinteger

Location ID

public_idstring nullable

Public ID

workspace_idinteger

Workspace ID

namestring

Location name

address_namestring

Address name

email_addressstring

Email address

phone_numberstring nullable

Phone number

sort_orderinteger nullable

Sort order

archivedboolean

Indicates if the location is archived

external_appboolean nullable

External app

created_atstring nullable

Added

updated_atstring nullable

Updated

Example response

[
  {
    "id": 2,
    "public_id": "jEvMrK",
    "workspace_id": 42000,
    "name": "Example Location",
    "address_name": "Example Address",
    "email_address": "myemail1754939677@example.com",
    "phone_number": "(123)-555-4567",
    "sort_order": 1,
    "archived": false,
    "external_app": true,
    "created_at": null,
    "updated_at": null,
    "address": {
      "address_one": "3443 W. Bavaria St.",
      "address_two": "Suite 100",
      "city": "Eagle",
      "region": "Idaho",
      "country": "US",
      "postal_code": "83616"
    }
  }
]

Changes

  • 511d88b30aeaRevision changes
    • info

      added the new optional query request parameter per_page

    • info

      for the path request parameter workspace_id, the type was generalized from integer to string

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status