younifyd
Menu

Get V2 Account Addresses

Get Account Addresses

GET/v2/accounts/{accountID}/addresses

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the Get V2 Account Addresses action (under Account Addresses).
  3. Fill in the fields below, then reference the result from later steps as {{getV2AccountAddresses.response.data}}.

Request

Path parameters

accountIDstringrequired

The ID of the account you want to retrieve.

Query parameters

page[offset]integer

The number of records to offset the results by.

Default 0

page[limit]integer

The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API.

Default 25

page[total_method]string

The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page.

One oflower_boundobservedDefault "lower_bound"

filterstring

Filter addresses using a simple query language.

Response

Returns 200 with an object. Read it in later steps with {{getV2AccountAddresses.response.data.<field>}}.

dataarray<any>
metaobject
pageobject4 fields
resultsobject2 fields
linksobject
currentstring

The URL to the current page.

firststring

The URL to the first page.

laststring | null

The URL to the last page. May be null if the total is unknown.

nextstring | null

The URL to the next page. Null if on the last page.

prevstring | null

The URL to the previous page. Null if on the first page.

json
{
  "data": [
    null
  ],
  "meta": {
    "page": {
      "limit": 25,
      "offset": 0,
      "current": 1,
      "total": 3
    },
    "results": {
      "total": 75,
      "total_method": "exact"
    }
  },
  "links": {
    "current": "https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=0&page[limit]=25",
    "first": "https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=0&page[limit]=25",
    "last": "https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=50&page[limit]=25",
    "next": "https://useast.api.elasticpath.com/v2/accounts/deb6b25f-8451-4211-9a22-95610333df23/addresses?page[offset]=25&page[limit]=25",
    "prev": null
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.