Profile list
Documentation for Profile list
읽는 시간 1분최근 업데이트: 일 년 전
Get all profiles for an
<accountserviceid>https://api.multiplay.co.uk/cfp/v1/profile/list
| METHOD |
| GET |
Request parameters
| VARIABLE | DESCRIPTION | OPTIONAL |
| accountserviceid | The | No |
| profileid | The | Yes |
| modid | The | Yes |
| game_build | The | Yes |
| settings | The If set to If set to | Yes |
Response fields
Field | Type | Description | Optional |
|---|---|---|---|
| profiles | array | List of profile objects | No |
Profile object
Field | Type | Description | Optional |
|---|---|---|---|
| profileid | integer | ID of the profile | No |
| gameversionid | integer | ID of the game version connected to this profile | No |
| name | string | Name of this profile | No |
| modid | integer | ID of the mod connected to this profile | No |
| gameid | integer | ID of the game connected to this profile | No |
| gametype_identifier | string | Game type identifier of this profile | No |
| settings | object | Map containing setting name string to setting value string | No |
| fleetid | string | Fleet ID connected to this profile | No |
Example request
curl --location --request GET 'https://api.multiplay.co.uk/cfp/v1/profile/list?accountserviceid=<accountserviceid>&settings=<settings>&game_build=<game_build>' \--header 'Authorization: Basic YOUR_AUTH_CREDENTIALS'
Example response
{ "profiles": [ { "profileid": <profileid>, "gameversionid": <gameversionid>, "name": <name>, "modid": <modid>, "gameid": <gameid>, "gametype_identifier": <gametype_identifier>, "settings": { "setting1": <setting_value>, "setting2": <setting_value>, ... }, "fleetid": <fleetid> }, ... ]}