Skip to main content

Player relationships API

Talo's player relationships API is the easiest way to build friends lists, follower systems, party invites and other social features that need player-to-player connections.

Endpoints


List subscriptions from players who have subscribed to the current player

read:playerRelationships
GET https://api.trytalo.com/v1/players/relationships/subscribers

Headers

KeyRequiredDescription
x-talo-alias NoThe ID of the player's alias

Route params

None available

Query keys

KeyRequiredDescription
aliasId NoFilter by a specific subscriber alias ID
confirmed NoFilter by confirmation status (true or false)
page NoPage number for pagination (default: 0)
relationshipType NoFilter by relationship type (unidirectional or bidirectional)

Sample response

{ ... }

List subscriptions where the current player is the subscriber

read:playerRelationships
GET https://api.trytalo.com/v1/players/relationships/subscriptions

Headers

KeyRequiredDescription
x-talo-alias NoThe ID of the player's alias

Route params

None available

Query keys

KeyRequiredDescription
aliasId NoFilter by a specific subscribed-to alias ID
confirmed NoFilter by confirmation status (true or false)
page NoPage number for pagination (default: 0)
relationshipType NoFilter by relationship type (unidirectional or bidirectional)

Sample response

{ ... }

Create a subscription request to another player

write:playerRelationships
POST https://api.trytalo.com/v1/players/relationships

Headers

KeyRequiredDescription
x-talo-alias NoThe ID of the player's alias

Route params

None available

Query keys

None available

Body keys

KeyRequiredDescription
aliasId YesThe ID of the player alias to subscribe to
relationshipType YesThe type of relationship: "unidirectional" or "bidirectional"

Sample request

{ ... }

Sample response

{ ... }

Confirm a pending subscription request

write:playerRelationships
PUT https://api.trytalo.com/v1/players/relationships/:id/confirm

Headers

KeyRequiredDescription
x-talo-alias NoThe ID of the player's alias

Route params

KeyRequiredDescription
id YesThe ID of the subscription request to confirm

Query keys

None available

Body keys

None available

Sample response

{ ... }

Delete a subscription (unsubscribe from a player)

write:playerRelationships
DELETE https://api.trytalo.com/v1/players/relationships/:id

Headers

KeyRequiredDescription
x-talo-alias NoThe ID of the player's alias

Route params

KeyRequiredDescription
id YesThe ID of the subscription to delete

Query keys

None available

Body keys

None available