Explore
Peopel API
1.0
OAS 3.0
Authorize
default
GET
/people
/me
Get person level information of the current user
PATCH
/people
/me
Update person level information
POST
/people
Create a Person (INTERNAL)
GET
/people
Search people
GET
/people
/{uuid}
Get details of a specific person
GET
/accounts
/me
Get account information
POST
/accounts
Create an Account (INTERNAL)
DELETE
/accounts
/{uuid}
Permanently delete the account and all records associated with it.
GET
/health
Health check endpoint used by the load balancer. Not to be called by the app. (INTERNAL)
POST
/connections
Request to connect with a target person
GET
/connections
Get a list of connection requests
PATCH
/connections
/{uuid}
/accept
Accept a connection request
PATCH
/connections
/{uuid}
/reject
Reject a connection request
GET
/connections
/contacts
Get a list of connected people
DELETE
/connections
/contacts
/{uuid}
Delete a connected person
POST
/chats
Start a new chat with a contact or a listing.
GET
/chats
Get a list of chats
GET
/chats
/{chatUuid}
/messages
Get a list of messages of a given Chat based on the filters
POST
/messages
/{wsConnId}
Send a Message to a Chat via WebSocket (INTERNAL)
POST
/ws_connections
Create a WebSocket connection (INTERNAL)
GET
/ws_connections
Get a list of WsConnection
PATCH
/ws_connections
/{wsConnId}
Update a WsConnection based on WebSocket connection ID (INTERNAL). The only field to be updated to status (e.g., to disconnect).
POST
/assets
Create an asset
GET
/assets
Get a list of assets by parentId and parentType. The field `presignedDownloadUrl` in the response is a short-lived secure URL to download the binary from CloudFront CDN.
DELETE
/assets
/{uuid}
Delete an asset
POST
/experiences
Post an experience
GET
/experiences
Get a list of experiences that are visible to the current user (e.g. own or public or contacts' experiences) and are satisfied by the filters.
GET
/experiences
/{uuid}
Get details of a specific experience
DELETE
/experiences
/{uuid}
Delete an experience.
POST
/experiences
/{experienceUuid}
/experience_reactions
Post a reaction on an experience
GET
/experiences
/{experienceUuid}
/experience_reactions
Get all the experience reactions of the given experience that are visible to the current user (e.g. own reactions or reactions from contacts).
DELETE
/experiences
/{experienceUuid}
/experience_reactions
/{uuid}
Delete an experience reaction.
POST
/devices
Register a device
Schemas
CreatePersonDto
UpdatePersonDto
CreateAccountDto
RemoveAccountDto
RequestConnectionDto
CreateChatDto
CreateMessageDto
CreateWsConnectionDto
UpdateWsConnectionDto
CreateAssetDto
CreateExperienceDto
CreateExperienceReactionDto
CreateDeviceDto
