API Search endpoints…⌘K

List all addresses for a Client

GET/lokta-lms/api/v1/client/{clientid}/addresses

Example Requests:

client/1/addresses

clients/1/addresses?status=false,true&&type=1,2,3

Path parameters

clientidpath · integer · int64 · required

clientId

Query parameters

statusquery · string · optional

status

typequery · integer · int64 · optional

type

Responses

defaultdefault response

Response fields

addressIdinteger · int64 · optional
addressLine1string · optional
addressLine2string · optional
addressLine3string · optional
addressTypestring · optional
addressTypeIdinteger · int64 · optional
addressTypeIdOptionsarray of CodeValueData · optional
citystring · optional
clientIDinteger · int64 · optional
countryIdinteger · int64 · optional
countryIdOptionsarray of CodeValueData · optional
countryNamestring · optional
countyDistrictstring · optional
createdBystring · optional
createdOnstring · date · optional
isActiveboolean · optional
latitudenumber · optional
longitudenumber · optional
postalCodestring · optional
stateNamestring · optional
stateProvinceIdinteger · int64 · optional
stateProvinceIdOptionsarray of CodeValueData · optional
streetstring · optional
townVillagestring · optional
updatedBystring · optional
updatedOnstring · date · optional

Every request authenticates with HTTP Basic and carries a Tenant-Identifier header. See the conventions for dates, commands, pagination and errors. Open this operation in the interactive explorer, or read it as Markdown.