API:2/mailcarriers
From Guild Wars 2 Wiki
< API:2
Jump to navigationJump to search
/v2/mailcarriers
- HTTP method
- GET
- Format
- json
- API version
- version 2
- Release date
- 2017-04-19
- Scope
- none
- Optional
- none
This resource returns information about mail carriers that are available in-game.
Endpoints
- None - Request the list of all available mail carrier
idswhen the root endpoint (v2/mailcarriers) has been accessed. id- (Optional) Request the mail carrier for the specifiedidwhen accessing the endpoint (v2/mailcarriers/id). Cannot be used when specifying theidsparameter.
Parameters
lang– (Optional) Request localized information.page- (Optional; integer)page_size- (Optional; integer)ids- (Optional; Comma Delimited List|all) Request an array of mail carriers for the specifiedidsor all mail carriers. Cannot be used when accessing theidendpoint.
Response
For each requested mail carrier id, an object with the following properties is returned:
id(integer) (default/null value: 0) - The id of the mail carrier.unlock_items(array of numbers) (optional) - An array of itemidsused to unlock the mailcarrier. Can be resolved against v2/itemsorder(integer) (default/null value: 0) - The order in which the mailcarrier appears in a list.icon(string) (default/null value: "") - Theiconuri for the mail carrier.name(string) (default/null value: "") - The name of the mailcarrier as it appears in-game.flags(array of strings)(default to an empty array) - Additional flags on the item, such as"Default"
Example
https://api.guildwars2.com/v2/mailcarriers/1
{
"id": 1,
"unlock_items": [
68102
],
"order": 4,
"icon": "https://render.guildwars2.com/file/DC800626B873260155C528297325C07635FFD41E/924620.png",
"name": "Confetti Mail Delivery",
"flags": [ ]
}
https://api.guildwars2.com/v2/mailcarriers/4
{
"id": 4,
"unlock_items": [ ],
"order": 0,
"icon": "https://render.guildwars2.com/file/2364A16ED4095005A090712A4910BF2701B77A0C/919381.png",
"name": "Mail-Carrier Pigeon",
"flags": [
"Default"
]
}
