HomePricingLogin

Party

Trusted Server API References for Party Service

Retrieves a party by its unique identifier.

get
Path parameters
partyIdinteger · int32Required
Responses
200
OK
get
GET /server/services/party/{partyId} HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "row": {
    "id": 1,
    "name": "text",
    "desc": "text",
    "image": "text",
    "max_member_count": 1,
    "is_private": true,
    "teams": "text",
    "channels": "text",
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "owner": 1,
    "created_at": "2025-07-03T12:26:03.212Z"
  }
}

Creates a new party based on the specified parameters.

post
Query parameters
playerinteger · int32Optional
Body
Responses
200
OK
post
POST /server/services/party HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "data": {
    "name": "text",
    "desc": "text",
    "image": "text",
    "max_member_count": 1,
    "is_private": true,
    "teams": [
      "text"
    ],
    "channels": [
      "text"
    ],
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}
200

OK

{
  "row": {
    "id": 1,
    "name": "text",
    "desc": "text",
    "image": "text",
    "max_member_count": 1,
    "is_private": true,
    "teams": "text",
    "channels": "text",
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "owner": 1,
    "created_at": "2025-07-03T12:26:03.212Z"
  }
}

Retrieves a list of members in a specified party.

get
Path parameters
partyIdinteger · int32Required
Query parameters
skipinteger · int32OptionalDefault: 0
limitinteger · int32OptionalDefault: 50
Responses
200
OK
get
GET /server/services/party/{partyId}/members HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "image": "text",
      "username": "text",
      "label": "text",
      "tags": "text",
      "is_ban": true,
      "is_tester": true,
      "is_guest": true,
      "first_login": "2025-07-03T12:26:03.212Z",
      "last_login": "2025-07-03T12:26:03.212Z",
      "role": 1,
      "status": 0,
      "data": "text",
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "channels": "text",
      "team": "text"
    }
  ],
  "totalCount": 1
}

Retrieves a list of parties based on the specified parameters.

get
Query parameters
querystringOptionalDefault: ""
skipinteger · int32OptionalDefault: 0
limitinteger · int32OptionalDefault: 50
Responses
200
OK
get
GET /server/services/party HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "desc": "text",
      "image": "text",
      "max_member_count": 1,
      "is_private": true,
      "teams": "text",
      "channels": "text",
      "data": "text",
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "owner": 1,
      "created_at": "2025-07-03T12:26:03.212Z"
    }
  ],
  "totalCount": 1
}

Retrieves a list of parties the user has subscribed to.

get
Query parameters
playerinteger · int32Optional
querystringOptionalDefault: ""
skipinteger · int32OptionalDefault: 0
limitinteger · int32OptionalDefault: 50
Responses
200
OK
get
GET /server/services/party/me HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "list": [
    {
      "id": 1,
      "name": "text",
      "desc": "text",
      "image": "text",
      "max_member_count": 1,
      "is_private": true,
      "teams": "text",
      "channels": "text",
      "data": "text",
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "owner": 1,
      "created_at": "2025-07-03T12:26:03.212Z"
    }
  ],
  "totalCount": 1
}

Retrieves a list of members waiting for approval to join a specified party.

get
Path parameters
partyIdinteger · int32Required
Query parameters
playerinteger · int32Optional
skipinteger · int32OptionalDefault: 0
limitinteger · int32OptionalDefault: 50
Responses
200
OK
get
GET /server/services/party/{partyId}/waiting HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "list": [
    {
      "id": 1,
      "party": 1,
      "player": 1,
      "role": 1,
      "status": 0,
      "data": "text",
      "variables": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "channels": "text",
      "team": "text"
    }
  ],
  "totalCount": 1
}

Joins a user to a specified party.

post
Path parameters
partyIdinteger · int32Required
Query parameters
playerinteger · int32Optional
Body
teamstring | nullableOptional
channelsstring[] | nullableOptional
Responses
200
OK
post
POST /server/services/party/{partyId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "team": "text",
  "channels": [
    "text"
  ]
}
200

OK

{
  "row": {
    "id": 1,
    "party": 1,
    "player": 1,
    "role": 1,
    "status": 0,
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "channels": "text",
    "team": "text"
  }
}

Edits the details of a specified party.

put
Path parameters
partyIdinteger · int32Required
Query parameters
playerinteger · int32Optional
Body
Responses
200
OK
put
PUT /server/services/party/{partyId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "data": {
    "id": 1,
    "name": "text",
    "desc": "text",
    "image": "text",
    "max_member_count": 1,
    "is_private": true,
    "teams": "text",
    "channels": "text",
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "owner": 1
  }
}
200

OK

{
  "row": {
    "id": 1,
    "party": 1,
    "player": 1,
    "role": 1,
    "status": 0,
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "channels": "text",
    "team": "text"
  }
}

Removes a user from a specified party.

delete
Path parameters
partyIdinteger · int32Required
Query parameters
playerinteger · int32Optional
Responses
200
OK
delete
DELETE /server/services/party/{partyId} HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "row": {
    "id": 1,
    "party": 1,
    "player": 1,
    "role": 1,
    "status": 0,
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "channels": "text",
    "team": "text"
  }
}

Accepts a member's request to join a specified party.

put
Path parameters
partyIdinteger · int32Required
membershipIdinteger · int32Required
Query parameters
callerinteger · int32Optional
Responses
200
OK
put
PUT /server/services/party/{partyId}/waiting/{membershipId} HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "row": {
    "id": 1,
    "party": 1,
    "player": 1,
    "role": 1,
    "status": 0,
    "data": "text",
    "variables": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "channels": "text",
    "team": "text"
  }
}

Rejects a member's request to join a specified party.

delete
Path parameters
partyIdinteger · int32Required
membershipIdinteger · int32Required
Query parameters
callerinteger · int32Optional
Responses
200
OK
delete
DELETE /server/services/party/{partyId}/waiting/{membershipId} HTTP/1.1
Host: 
Accept: */*
200

OK

{
  "affected": 1
}
PreviousLeeaderboardNextSupport & Troubleshooting

Last updated