Get Usergroup Address by Id

GET 
/usergroups/:lookupKey/:lookupValue/addresses/:addressId

Use this endpoint to retrieve details for a usergroup address. The address is identified by id.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about usergroup lookup keys

lookupValue stringrequired

The value of the key (id or sourceId)

addressId stringrequired

Address id

Responses

200

Get Usergroup Address by Id - 200

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object

active string

city string

code string

company string

country string

email string

fax string

firstName string

gender string

icp string

id number

isDefault string

lastName string

middleName string

mobile string

name string

notes string

number string

numberExtension string

phone string

postalCode string

region string

street string

type string

url string
messages undefined[]
total number

Example (from schema)

{
  "data": {
    "active": "Y",
    "city": "Arnhem",
    "code": "11234",
    "company": "Propel",
    "country": "NL",
    "email": "miles@propel.us",
    "fax": "",
    "firstName": "Miles",
    "gender": "U",
    "icp": "N",
    "id": 81918,
    "isDefault": "N",
    "lastName": "McCoy",
    "middleName": "",
    "mobile": "0038975648",
    "name": "",
    "notes": "Address notes",
    "number": "34",
    "numberExtension": "A",
    "phone": "0032445888",
    "postalCode": "6822 DE",
    "region": "",
    "street": "Noordpad",
    "type": "delivery",
    "url": "www.propel.us"
  },
  "messages": [],
  "total": 1
}

Get Usergroup Address by Id - 200

{
  "data": {
    "active": "Y",
    "city": "Arnhem",
    "code": "11234",
    "company": "Propel",
    "country": "NL",
    "email": "miles@propel.us",
    "fax": "",
    "firstName": "Miles",
    "gender": "U",
    "icp": "N",
    "id": 81918,
    "isDefault": "N",
    "lastName": "McCoy",
    "middleName": "",
    "mobile": "0038975648",
    "name": "",
    "notes": "Address notes",
    "number": "34",
    "numberExtension": "A",
    "phone": "0032445888",
    "postalCode": "6822 DE",
    "region": "",
    "street": "Noordpad",
    "type": "delivery",
    "url": "www.propel.us"
  },
  "messages": [],
  "total": 1
}

404

Get Usergroup Address by Id - 404 (address not found) / Get Usergroup Address by Id - 404 (usergroup not found)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 90006,
    "messages": [
      "Address with id [819181] not found for [Usergroup] with id [122]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/90006",
    "status": 404,
    "type": "AddressNotFound"
  }
}

Get Usergroup Address by Id - 404 (address not found)

{
  "error": {
    "code": 90006,
    "messages": [
      "Address with id [819181] not found for [Usergroup] with id [122]"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/90006",
    "status": 404,
    "type": "AddressNotFound"
  }
}

Get Usergroup Address by Id - 404 (usergroup not found)

{
  "error": {
    "code": 20007,
    "messages": [
      "Parent resource [Usergroup] with id [12256] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/20007",
    "status": 404,
    "type": "ParentUsergroupNotFound"
  }
}

Loading...