List profiles

Last updated 4 months ago

List profiles

Get all profiles for an account service ID, with optional filters by profile ID, mod ID, or game build. Optionally includes settings information.

Endpoint

GET /cfp/v1/profile/list

Query Parameters

Name	Type	Required	Description
`profileid`	integer	No	One or more profile IDs to filter by. Can be repeated (e.g. profileid=1&profileid=2).
`modid`	string	No	One or more mod IDs to filter by. Can be repeated (e.g. modid=1&modid=2).
`game_build`	string	No	One or more game builds to filter by. Can be repeated (e.g. game_build=v1&game_build=v2).
`settings`	boolean	No	If true, each profile includes settings information in the response. If false or excluded, no settings information is included.

Example Request

curl -X GET "https://api.multiplay.dev/cfp/v1/profile/list?profileid=<profileid>&modid=<modid>&game_build=<game_build>&settings=<settings>" \
  -H "Authorization: Bearer <token>"

Responses

Status	Description
`200`	Successful response with profile list.
`400`
`401`
`403`
`500`