For the complete documentation index, see llms.txt.

Models

Starshipit API model

Get Addresses - Address Model

Field names, types, and descriptions for this shared API model.

13 fields

AttributeTypeDescription
idintegerThe unique numeric identifier for the address
namestringContact name at this address
companystringThe country name of receiver address
buildingstringName of the building at the address
streetstringStreet Name and number
suburbstringSuburb or locality
post_codeintegerPostal code
citystringTown or city
statestringState, region, province or county name
countrystringCountry name
codenumberInternal identifier for this contact
telephonestringPhone number for this contact
emailbooleanEmail address for this contact