> For the complete documentation index, see [llms.txt](https://dynamicpixels.gitbook.io/dynamicpixels-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://dynamicpixels.gitbook.io/dynamicpixels-docs/web-api/party.md).

# Party

Explore the list of Web APIs functions available for party service, including detailed descriptions and usage examples.

{% hint style="warning" %}
To use service functions, first ensure that the service is activated before. You can see services by opening "Service Hub" From the game's dashboard header. 
{% endhint %}

## PUT /api/table/services/parties/{partyId}

> Edits the details of a specified party.

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties/{partyId}":{"put":{"tags":["Parties"],"summary":"Edits the details of a specified party.","operationId":"EditParty","parameters":[{"name":"partyId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditPartyParam"}},"text/json":{"schema":{"$ref":"#/components/schemas/EditPartyParam"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/EditPartyParam"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}}}}}}}},"components":{"schemas":{"EditPartyParam":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Party"}},"additionalProperties":false},"Party":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"desc":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"max_member_count":{"type":"integer","format":"int32"},"is_private":{"type":"boolean"},"teams":{"type":"string","nullable":true},"channels":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"owner":{"type":"integer","format":"int32"}},"additionalProperties":false},"PartyMemberRowResponse":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/PartyMember"}},"additionalProperties":false},"PartyMember":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"party":{"type":"integer","format":"int32"},"player":{"type":"integer","format":"int32"},"role":{"$ref":"#/components/schemas/PartyMemberRoles"},"status":{"$ref":"#/components/schemas/PartyMemberStatus"},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"channels":{"type":"string","nullable":true},"team":{"type":"string","nullable":true}},"additionalProperties":false},"PartyMemberRoles":{"enum":[1,2,3],"type":"integer","format":"int32"},"PartyMemberStatus":{"enum":[0,1],"type":"integer","format":"int32"}}}}
```

## POST /api/table/services/parties

> Creates a new party based on the specified parameters.

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties":{"post":{"tags":["Parties"],"summary":"Creates a new party based on the specified parameters.","operationId":"CreateParty","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePartyParam"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreatePartyParam"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreatePartyParam"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PartyDtoRowResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PartyDtoRowResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartyDtoRowResponse"}}}}}}}},"components":{"schemas":{"CreatePartyParam":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PartyInput"}},"additionalProperties":false},"PartyInput":{"type":"object","properties":{"name":{"type":"string","nullable":true},"desc":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"max_member_count":{"type":"integer","format":"int32"},"is_private":{"type":"boolean"},"teams":{"type":"array","items":{"type":"string"},"nullable":true},"channels":{"type":"array","items":{"type":"string"},"nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}},"additionalProperties":false},"PartyDtoRowResponse":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/PartyDto"}},"additionalProperties":false},"PartyDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"desc":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"max_member_count":{"type":"integer","format":"int32"},"is_private":{"type":"boolean"},"teams":{"type":"string","nullable":true},"channels":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"owner":{"type":"integer","format":"int32","nullable":true},"created_at":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## POST /api/table/services/parties/{partyId}

> Joins a user to a specified party.

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties/{partyId}":{"post":{"tags":["Parties"],"summary":"Joins a user to a specified party.","operationId":"JoinToParty","parameters":[{"name":"partyId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JoinToPartyParam"}},"text/json":{"schema":{"$ref":"#/components/schemas/JoinToPartyParam"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/JoinToPartyParam"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}}}}}}}},"components":{"schemas":{"JoinToPartyParam":{"type":"object","properties":{"team":{"type":"string","nullable":true},"channels":{"type":"array","items":{"type":"string"},"nullable":true}},"additionalProperties":false},"PartyMemberRowResponse":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/PartyMember"}},"additionalProperties":false},"PartyMember":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"party":{"type":"integer","format":"int32"},"player":{"type":"integer","format":"int32"},"role":{"$ref":"#/components/schemas/PartyMemberRoles"},"status":{"$ref":"#/components/schemas/PartyMemberStatus"},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"channels":{"type":"string","nullable":true},"team":{"type":"string","nullable":true}},"additionalProperties":false},"PartyMemberRoles":{"enum":[1,2,3],"type":"integer","format":"int32"},"PartyMemberStatus":{"enum":[0,1],"type":"integer","format":"int32"}}}}
```

## GET /api/table/services/parties/{partyId}

> Retrieves a party by its unique identifier.

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties/{partyId}":{"get":{"tags":["Parties"],"summary":"Retrieves a party by its unique identifier.","operationId":"GetPartyById","parameters":[{"name":"partyId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PartyDtoRowResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PartyDtoRowResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartyDtoRowResponse"}}}}}}}},"components":{"schemas":{"PartyDtoRowResponse":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/PartyDto"}},"additionalProperties":false},"PartyDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"desc":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"max_member_count":{"type":"integer","format":"int32"},"is_private":{"type":"boolean"},"teams":{"type":"string","nullable":true},"channels":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"owner":{"type":"integer","format":"int32","nullable":true},"created_at":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## GET /api/table/services/parties

> Retrieves a list of parties based on the specified parameters.

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties":{"get":{"tags":["Parties"],"summary":"Retrieves a list of parties based on the specified parameters.","operationId":"GetParties","parameters":[{"name":"query","in":"query","schema":{"type":"string","default":""}},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PartyDtoRowsResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PartyDtoRowsResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartyDtoRowsResponse"}}}}}}}},"components":{"schemas":{"PartyDtoRowsResponse":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PartyDto"},"nullable":true},"totalCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"PartyDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"desc":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"max_member_count":{"type":"integer","format":"int32"},"is_private":{"type":"boolean"},"teams":{"type":"string","nullable":true},"channels":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"owner":{"type":"integer","format":"int32","nullable":true},"created_at":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```

## GET /api/table/services/parties/{partyId}/members

> Retrieves a list of members in a specified party.

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties/{partyId}/members":{"get":{"tags":["Parties"],"summary":"Retrieves a list of members in a specified party.","operationId":"GetPartyMembers","parameters":[{"name":"partyId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/RichPartyMemberRowsResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/RichPartyMemberRowsResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/RichPartyMemberRowsResponse"}}}}}}}},"components":{"schemas":{"RichPartyMemberRowsResponse":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/RichPartyMember"},"nullable":true},"totalCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"RichPartyMember":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"username":{"type":"string","nullable":true},"label":{"type":"string","nullable":true},"tags":{"type":"string","nullable":true},"is_ban":{"type":"boolean"},"is_tester":{"type":"boolean"},"is_guest":{"type":"boolean"},"first_login":{"type":"string","format":"date-time","nullable":true},"last_login":{"type":"string","format":"date-time","nullable":true},"role":{"$ref":"#/components/schemas/PartyMemberRoles"},"status":{"$ref":"#/components/schemas/PartyMemberStatus"},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"channels":{"type":"string","nullable":true},"team":{"type":"string","nullable":true}},"additionalProperties":false},"PartyMemberRoles":{"enum":[1,2,3],"type":"integer","format":"int32"},"PartyMemberStatus":{"enum":[0,1],"type":"integer","format":"int32"}}}}
```

## GET /api/table/services/parties/{partyId}/waiting

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

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties/{partyId}/waiting":{"get":{"tags":["Parties"],"summary":"Retrieves a list of members waiting for approval to join a specified party.","operationId":"GetPartyWaitingMembers","parameters":[{"name":"partyId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PartyMemberRowsResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PartyMemberRowsResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartyMemberRowsResponse"}}}}}}}},"components":{"schemas":{"PartyMemberRowsResponse":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PartyMember"},"nullable":true},"totalCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"PartyMember":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"party":{"type":"integer","format":"int32"},"player":{"type":"integer","format":"int32"},"role":{"$ref":"#/components/schemas/PartyMemberRoles"},"status":{"$ref":"#/components/schemas/PartyMemberStatus"},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"channels":{"type":"string","nullable":true},"team":{"type":"string","nullable":true}},"additionalProperties":false},"PartyMemberRoles":{"enum":[1,2,3],"type":"integer","format":"int32"},"PartyMemberStatus":{"enum":[0,1],"type":"integer","format":"int32"}}}}
```

## DELETE /api/table/services/parties/{partyId}

> Removes a user from a specified party.

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties/{partyId}":{"delete":{"tags":["Parties"],"summary":"Removes a user from a specified party.","operationId":"LeaveParty","parameters":[{"name":"partyId","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartyMemberRowResponse"}}}}}}}},"components":{"schemas":{"PartyMemberRowResponse":{"type":"object","properties":{"row":{"$ref":"#/components/schemas/PartyMember"}},"additionalProperties":false},"PartyMember":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"party":{"type":"integer","format":"int32"},"player":{"type":"integer","format":"int32"},"role":{"$ref":"#/components/schemas/PartyMemberRoles"},"status":{"$ref":"#/components/schemas/PartyMemberStatus"},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"channels":{"type":"string","nullable":true},"team":{"type":"string","nullable":true}},"additionalProperties":false},"PartyMemberRoles":{"enum":[1,2,3],"type":"integer","format":"int32"},"PartyMemberStatus":{"enum":[0,1],"type":"integer","format":"int32"}}}}
```

## GET /api/table/services/parties/me

> Retrieves a list of parties the user has subscribed to.

```json
{"openapi":"3.0.4","info":{"title":"DynamicPixels GameService V2","version":"v2"},"paths":{"/api/table/services/parties/me":{"get":{"tags":["Parties"],"summary":"Retrieves a list of parties the user has subscribed to.","operationId":"GetSubscribedParties","parameters":[{"name":"query","in":"query","schema":{"type":"string","default":""}},{"name":"skip","in":"query","schema":{"type":"integer","format":"int32","default":0}},{"name":"limit","in":"query","schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/PartyDtoRowsResponse"}},"application/json":{"schema":{"$ref":"#/components/schemas/PartyDtoRowsResponse"}},"text/json":{"schema":{"$ref":"#/components/schemas/PartyDtoRowsResponse"}}}}}}}},"components":{"schemas":{"PartyDtoRowsResponse":{"type":"object","properties":{"list":{"type":"array","items":{"$ref":"#/components/schemas/PartyDto"},"nullable":true},"totalCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"PartyDto":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"name":{"type":"string","nullable":true},"desc":{"type":"string","nullable":true},"image":{"type":"string","nullable":true},"max_member_count":{"type":"integer","format":"int32"},"is_private":{"type":"boolean"},"teams":{"type":"string","nullable":true},"channels":{"type":"string","nullable":true},"data":{"type":"string","nullable":true},"variables":{"type":"object","additionalProperties":{"type":"string"},"nullable":true},"owner":{"type":"integer","format":"int32","nullable":true},"created_at":{"type":"string","format":"date-time"}},"additionalProperties":false}}}}
```