Profiles

Funplace is profile-based, so any API call requires a profile ID.

API base url: https://funplace.fun/api/v1/user/profiles/

Get profiles linked to an account

GET get

scopes: Funplace::view or Funplace::profile

Exchange Bearer token for a list of profiles affiliated with the Vorg ID account.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <access_token>

Response

200

{
  "success": "ok",
  "data": [{
    "funprofile_id": 42,
    "role": "owner"
  }],
}

400

401

Response body (If successful)

Parameter	Required?	Type	Description
success	yes	string	Always have the value ok.
data	yes	array	An array with information about profiles.
data[?][funprofile_id]	yes	int	Profile id.
data[?][role]	yes	string	One of roles.

Get accounts linked to an profile

GET list

scopes: Funplace::profile

Get a list of accounts that have access to a profile.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <access_token>
FUNPLACE-PROFILE-ID	<profile_id>

Response

200

{
  "success": "ok",
  "data": [{
    "vorgid": 42,
    "role": "owner"
  }],
}

400

401

Response body (If successful)

Parameter	Required?	Type	Description
success	yes	string	Always have the value ok.
data	yes	array	An array with information about accounts.
data[?][vorgid]	yes	int	Vorg id.
data[?][role]	yes	string	One of roles.

Create profile

GET create

scopes: Funplace::profiles

Create funplace profile.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <access_token>

Response

200

{
  "success": "ok",
  "funprofile_id": 42,
}

400

401

Response body (If successful)

Parameter	Required?	Type	Description
success	yes	string	Always have the value ok.
funprofile_id	yes	int	Profile id.

Invite user to the profile

GET invite

scopes: Funplace::prfolies::invite

Invite the user to your profile.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <access_token>
FUNPLACE-PROFILE-ID	<profile id>

Query Parameters

Parameter	Required?	Type	Description
email	no	string	email of the invited user.
id	no	int	Vorg ID of the invited user
role	yes	string	Any supported role.

Response

200

{
  "success": "ok",
}

400

401

Response body (If successful)

Parameter	Required?	Type	Description
success	yes	string	Always have the value ok.

Block invites

GET blockinvites

scopes: Funplace::prfolies

Prevent people from inviting you to profiles.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <access_token>

Query Parameters

Parameter	Required?	Type	Description
state	yes	boolean	Should enable blocking?

Response

200

{
  "success": "ok",
}

400

401

Response body (If successful)

Parameter	Required?	Type	Description
success	yes	string	Always have the value ok.

Edit user role

GET invite

scopes: Funplace::prfolies

Change the role or exclude the user from the profile.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <access_token>
FUNPLACE-PROFILE-ID	<profile id>

Query Parameters

Parameter	Required?	Type	Description
role	yes	string	Any supported role or unset value for remove user.

Response

200

{
  "success": "ok",
}

400

401

Response body (If successful)

Parameter	Required?	Type	Description
success	yes	string	Always have the value ok.

Quit profile

GET quit

scopes: Funplace::prfolies

Leave the profile yourself.

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <access_token>
FUNPLACE-PROFILE-ID	<profile id>

Response

200

{
  "success": "ok",
}

400

401

Response body (If successful)

Parameter	Required?	Type	Description
success	yes	string	Always have the value ok.

Roles

Role	Access	Desc
owner	full	Issued to the profile creator at the time of creation and to no one else.
manager	Full access except for changing member access levels to the profile and actions related to withdrawal of funds.	An account manager can be issued to anyone.
moderator	Only viewing account information and the ability to skip alert.	An account moderator can be issued to anyone.
viewer	Only view access.	An account moderator can be issued to anyone.