{
"components": {
"schemas": {
"AccountInfo": {
"properties": {
"account": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"subscription": true
},
"required": [
"subscription",
"account"
],
"title": "AccountInfo",
"type": "object"
},
"ActivePill": {
"properties": {
"id": {
"type": "string"
},
"permission": {
"type": "string"
},
"pillType": {
"type": "string"
}
},
"required": [
"pillType",
"permission",
"id"
],
"title": "ActivePill",
"type": "object"
},
"AnswerContentPayload": {
"properties": {
"position": {
"format": "int32",
"type": "integer"
},
"questionId": {
"type": "string"
},
"textAnswer": true,
"voiceAnswer": {
"anyOf": [
{
"$ref": "#/components/schemas/VoiceAnswerPayload"
},
{
"type": "null"
}
]
}
},
"required": [
"position",
"questionId"
],
"title": "AnswerContentPayload",
"type": "object"
},
"AnswerEvaluateRequest": {
"properties": {
"answer": {
"type": "string"
},
"promptId": {
"type": "string"
}
},
"required": [
"answer",
"promptId"
],
"title": "AnswerEvaluateRequest",
"type": "object"
},
"AnswersUpdateRequest": {
"items": {
"$ref": "#/components/schemas/AnswerContentPayload"
},
"type": "array"
},
"AuthSettings": {
"properties": {
"appleAuthed": {
"type": "boolean"
},
"facebookAuthed": {
"type": "boolean"
},
"googleAuthed": {
"type": "boolean"
},
"smsAuthed": {
"type": "boolean"
}
},
"required": [
"appleAuthed",
"facebookAuthed",
"googleAuthed",
"smsAuthed"
],
"title": "AuthSettings",
"type": "object"
},
"BoundingBox": {
"properties": {
"bottomRight": {
"$ref": "#/components/schemas/Coordinate",
"default": {
"x": 0.0,
"y": 0.0
}
},
"topLeft": {
"$ref": "#/components/schemas/Coordinate",
"default": {
"x": 0.0,
"y": 0.0
}
}
},
"title": "BoundingBox",
"type": "object"
},
"ChildrenStatus": {
"properties": {
"value": {
"$ref": "#/components/schemas/ChildrenStatusProfile"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"ChildrenStatusPreference": {
"enum": [
"OpenToAll",
"No",
"Yes"
],
"type": "string"
},
"ChildrenStatusProfile": {
"enum": [
"PreferNotToSay",
"No",
"Yes"
],
"type": "string"
},
"ConnectionContentItem": {
"properties": {
"comment": {
"type": [
"string",
"null"
]
},
"photo": {
"anyOf": [
{
"$ref": "#/components/schemas/PhotoAsset"
},
{
"type": "null"
}
]
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectionPrompt"
},
{
"type": "null"
}
]
},
"video": {
"anyOf": [
{
"$ref": "#/components/schemas/ConnectionVideo"
},
{
"type": "null"
}
]
}
},
"title": "ConnectionContentItem",
"type": "object"
},
"ConnectionDetailApi": {
"properties": {
"initiatedWith": {
"default": "",
"type": "string"
},
"initiatorId": {
"default": "",
"type": "string"
},
"isHidden": {
"default": false,
"type": "boolean"
},
"receivedTime": {
"type": [
"string",
"null"
]
},
"sentContent": {
"default": [],
"items": {
"$ref": "#/components/schemas/ConnectionContentItem"
},
"type": "array"
},
"sentTime": {
"type": [
"string",
"null"
]
},
"showMatchNote": {
"type": [
"boolean",
"null"
]
},
"socialMediaExchangedTimestamp": {
"type": [
"string",
"null"
]
},
"source": {
"default": "",
"type": "string"
},
"subjectId": {
"default": "",
"type": "string"
}
},
"title": "ConnectionDetailApi",
"type": "object"
},
"ConnectionItem": {
"properties": {
"initiatedWith": {
"default": "",
"type": "string"
},
"initiatorId": {
"default": "",
"type": "string"
},
"isHidden": {
"default": false,
"type": "boolean"
},
"receivedTime": {
"type": [
"string",
"null"
]
},
"sentContent": {
"default": [],
"items": {
"$ref": "#/components/schemas/ConnectionContentItem"
},
"type": "array"
},
"sentTime": {
"type": [
"string",
"null"
]
},
"socialMediaExchangedTimestamp": {
"type": [
"string",
"null"
]
},
"source": {
"default": "",
"type": "string"
},
"subjectId": {
"default": "",
"type": "string"
}
},
"title": "ConnectionItem",
"type": "object"
},
"ConnectionPrompt": {
"properties": {
"answer": {
"default": "",
"type": "string"
},
"contentId": {
"type": [
"string",
"null"
]
},
"question": {
"default": "",
"type": "string"
}
},
"title": "ConnectionPrompt",
"type": "object"
},
"ConnectionVideo": {
"properties": {
"boundingBox": {
"anyOf": [
{
"$ref": "#/components/schemas/BoundingBox"
},
{
"type": "null"
}
]
},
"cdnId": {
"type": [
"string",
"null"
]
},
"contentId": {
"type": [
"string",
"null"
]
},
"thumbnail": {
"default": "",
"type": "string"
},
"url": {
"default": "",
"type": "string"
}
},
"title": "ConnectionVideo",
"type": "object"
},
"ConnectionsResponse": {
"properties": {
"connections": {
"default": [],
"items": {
"$ref": "#/components/schemas/ConnectionItem"
},
"type": "array"
},
"yourTurnMatchLimit": {
"default": 0,
"format": "int32",
"type": "integer"
}
},
"title": "ConnectionsResponse",
"type": "object"
},
"ContentData": {
"properties": {
"answers": {
"default": [],
"items": {
"$ref": "#/components/schemas/ProfileAnswer"
},
"type": "array"
},
"photos": {
"default": [],
"items": {
"$ref": "#/components/schemas/PhotoAsset"
},
"type": "array"
},
"promptPoll": {
"anyOf": [
{
"$ref": "#/components/schemas/PromptPoll"
},
{
"type": "null"
}
]
},
"videoPrompt": {
"anyOf": [
{
"$ref": "#/components/schemas/VideoPrompt"
},
{
"type": "null"
}
]
}
},
"title": "ContentData",
"type": "object"
},
"ContentType": {
"enum": [
"text",
"media",
"audio",
"video",
"voice",
"poll"
],
"type": "string"
},
"Coordinate": {
"properties": {
"x": {
"default": 0.0,
"format": "double",
"type": "number"
},
"y": {
"default": 0.0,
"format": "double",
"type": "number"
}
},
"type": "object"
},
"CreatePromptPollRequest": {
"properties": {
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"questionId": {
"type": "string"
}
},
"required": [
"options",
"questionId"
],
"title": "CreatePromptPollRequest",
"type": "object"
},
"CreatePromptPollResponse": {
"properties": {
"contentId": {
"type": "string"
}
},
"required": [
"contentId"
],
"title": "CreatePromptPollResponse",
"type": "object"
},
"CreateRate": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/components/schemas/CreateRateContent"
},
{
"type": "null"
}
]
},
"created": {
"type": "string"
},
"hasPairing": {
"default": false,
"type": "boolean"
},
"hcmRunId": {
"type": [
"string",
"null"
]
},
"initiatedWith": {
"type": [
"string",
"null"
]
},
"origin": {
"type": [
"string",
"null"
]
},
"rating": {
"type": "string"
},
"ratingId": {
"type": "string"
},
"ratingToken": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"required": [
"ratingId",
"sessionId",
"created",
"ratingToken",
"rating",
"subjectId"
],
"title": "CreateRate",
"type": "object"
},
"CreateRateContent": {
"properties": {
"comment": {
"type": [
"string",
"null"
]
},
"photo": {
"anyOf": [
{
"$ref": "#/components/schemas/PhotoAsset"
},
{
"type": "null"
}
]
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/CreateRateContentPrompt"
},
{
"type": "null"
}
]
}
},
"title": "CreateRateContent",
"type": "object"
},
"CreateRateContentPrompt": {
"properties": {
"answer": {
"type": "string"
},
"contentId": {
"type": [
"string",
"null"
]
},
"question": {
"type": "string"
}
},
"required": [
"answer",
"question"
],
"title": "CreateRateContentPrompt",
"type": "object"
},
"CreateVideoPromptRequest": {
"properties": {
"boundingBox": {
"$ref": "#/components/schemas/BoundingBox"
},
"cdnId": {
"type": "string"
},
"lengthSeconds": {
"format": "int32",
"type": "integer"
},
"questionId": {
"type": "string"
},
"source": {
"type": "string"
},
"thumbnailUrl": {
"type": "string"
},
"videoUrl": {
"type": "string"
}
},
"required": [
"questionId",
"thumbnailUrl",
"cdnId",
"boundingBox",
"videoUrl",
"source",
"lengthSeconds"
],
"title": "CreateVideoPromptRequest",
"type": "object"
},
"CreateVideoPromptResponse": {
"properties": {
"contentId": {
"type": "string"
}
},
"required": [
"contentId"
],
"title": "CreateVideoPromptResponse",
"type": "object"
},
"DatingIntention": {
"properties": {
"value": {
"$ref": "#/components/schemas/DatingIntentionProfile"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"DatingIntentionPreference": {
"enum": [
"OpenToAll",
"LifePartner",
"LongTermRelationship",
"LongTermOpenToShort",
"ShortTermOpenToLong",
"ShortTermRelationship",
"FiguringOutTheirDatingGoals"
],
"type": "string"
},
"DatingIntentionProfile": {
"enum": [
"PreferNotToSay",
"LifePartner",
"LongTermRelationship",
"LongTermOpenToShort",
"ShortTermOpenToLong",
"ShortTermRelationship",
"FiguringOutTheirDatingGoals"
],
"type": "string"
},
"Dealbreakers": {
"properties": {
"children": {
"type": "boolean"
},
"datingIntentions": {
"type": "boolean"
},
"drinking": {
"type": "boolean"
},
"drugs": {
"type": "boolean"
},
"educationAttained": {
"type": "boolean"
},
"ethnicities": {
"type": "boolean"
},
"familyPlans": {
"type": "boolean"
},
"genderedAge": {
"$ref": "#/components/schemas/GenderedDealbreaker"
},
"genderedHeight": {
"$ref": "#/components/schemas/GenderedDealbreaker"
},
"marijuana": {
"type": "boolean"
},
"maxDistance": {
"type": "boolean"
},
"politics": {
"type": "boolean"
},
"relationshipTypes": {
"type": "boolean"
},
"religions": {
"type": "boolean"
},
"smoking": {
"type": "boolean"
}
},
"required": [
"marijuana",
"smoking",
"maxDistance",
"drinking",
"educationAttained",
"genderedHeight",
"politics",
"relationshipTypes",
"drugs",
"datingIntentions",
"familyPlans",
"genderedAge",
"religions",
"ethnicities",
"children"
],
"title": "Dealbreakers",
"type": "object"
},
"DrinkingStatus": {
"properties": {
"value": {
"$ref": "#/components/schemas/DrinkingStatusProfile"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"DrinkingStatusPreference": {
"enum": [
"OpenToAll",
"No",
"Yes",
"Sometimes"
],
"type": "string"
},
"DrinkingStatusProfile": {
"enum": [
"PreferNotToSay",
"No",
"Yes",
"Sometimes"
],
"type": "string"
},
"DrugStatus": {
"properties": {
"value": {
"$ref": "#/components/schemas/DrugStatusProfile"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"DrugStatusPreference": {
"enum": [
"OpenToAll",
"No",
"Yes",
"Sometimes"
],
"type": "string"
},
"DrugStatusProfile": {
"enum": [
"PreferNotToSay",
"No",
"Yes",
"Sometimes"
],
"type": "string"
},
"EducationAttainedPreference": {
"enum": [
"OpenToAll",
"HighSchool",
"TradeSchool",
"InCollege",
"Undergraduate",
"InGradSchool",
"Graduate"
],
"type": "string"
},
"EducationAttainedProfile": {
"enum": [
"PreferNotToSay",
"HighSchool",
"TradeSchool",
"InCollege",
"Undergraduate",
"InGradSchool",
"Graduate"
],
"type": "string"
},
"Educations": {
"properties": {
"value": {
"items": {
"type": "string"
},
"type": "array"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"EmailCodeRequest": {
"additionalProperties": true,
"properties": {
"caseId": {
"type": "string"
},
"code": {
"type": "string"
},
"deviceId": {
"type": "string"
},
"installId": {
"type": "string"
}
},
"type": "object"
},
"EmptyObject": {
"additionalProperties": true,
"properties": {},
"type": "object"
},
"Error": {
"additionalProperties": true,
"properties": {
"error": {
"type": "string"
}
},
"type": "object"
},
"Ethnicities": {
"properties": {
"value": {
"items": {
"$ref": "#/components/schemas/EthnicityProfile"
},
"type": "array"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"EthnicityPreference": {
"enum": [
"OpenToAll",
"AmericanIndian",
"BlackAfrican",
"EastAsian",
"Hispanic",
"MiddleEastern",
"PacificIslander",
"SouthAsian",
"White",
"Other"
],
"type": "string"
},
"EthnicityProfile": {
"enum": [
"PreferNotToSay",
"AmericanIndian",
"BlackAfrican",
"EastAsian",
"Hispanic",
"MiddleEastern",
"PacificIslander",
"SouthAsian",
"White",
"Other"
],
"type": "string"
},
"ExportChatInput": {
"properties": {
"channelUrl": {
"type": "string"
},
"includeMedia": {
"default": false,
"type": "boolean"
},
"initiationSummaryLines": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"outputDir": {
"type": "string"
}
},
"required": [
"channelUrl",
"outputDir"
],
"title": "ExportChatInput",
"type": "object"
},
"ExportChatResult": {
"properties": {
"folderPath": {
"type": "string"
},
"mediaFiles": {
"items": {
"$ref": "#/components/schemas/ExportedMediaFile"
},
"type": "array"
},
"messageCount": {
"format": "int32",
"type": "integer"
},
"profilePath": {
"default": null,
"type": [
"string",
"null"
]
},
"transcriptPath": {
"type": "string"
}
},
"required": [
"folderPath",
"transcriptPath",
"messageCount",
"mediaFiles"
],
"title": "ExportChatResult",
"type": "object"
},
"ExportStatus": {
"properties": {
"created": {
"type": [
"string",
"null"
]
},
"status": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
}
},
"required": [
"status"
],
"title": "ExportStatus",
"type": "object"
},
"ExportedMediaFile": {
"properties": {
"fileName": {
"type": "string"
},
"filePath": {
"type": "string"
},
"messageId": {
"type": "string"
}
},
"required": [
"messageId",
"fileName",
"filePath"
],
"title": "ExportedMediaFile",
"type": "object"
},
"FamilyPlans": {
"properties": {
"value": {
"format": "int32",
"type": "integer"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"Feedback": {
"properties": {
"detail": {
"type": "string"
},
"evaluation": {
"type": "string"
},
"feedbackToken": {
"type": "string"
}
},
"required": [
"evaluation",
"detail",
"feedbackToken"
],
"title": "Feedback",
"type": "object"
},
"GenderEnum": {
"enum": [
"Man",
"Woman",
"NonBinary"
],
"type": "string"
},
"GenderIdentityId": {
"properties": {
"value": {
"format": "int32",
"type": "integer"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"GenderPreferences": {
"enum": [
"Men",
"Women",
"Everyone"
],
"type": "string"
},
"GenderedDealbreaker": {
"properties": {
"0": {
"type": [
"boolean",
"null"
]
},
"1": {
"type": [
"boolean",
"null"
]
},
"3": {
"type": [
"boolean",
"null"
]
}
},
"title": "GenderedDealbreaker",
"type": "object"
},
"GenderedRange": {
"properties": {
"0": {
"anyOf": [
{
"$ref": "#/components/schemas/RangeDetails"
},
{
"type": "null"
}
]
},
"1": {
"anyOf": [
{
"$ref": "#/components/schemas/RangeDetails"
},
{
"type": "null"
}
]
},
"3": {
"anyOf": [
{
"$ref": "#/components/schemas/RangeDetails"
},
{
"type": "null"
}
]
}
},
"title": "GenderedRange",
"type": "object"
},
"HingeAuthToken": {
"properties": {
"expires": {
"format": "date-time",
"type": "string"
},
"identityId": {
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"identityId",
"token",
"expires"
],
"title": "HingeAuthToken",
"type": "object"
},
"Hometown": {
"properties": {
"value": {
"type": "string"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"InstallRequest": {
"additionalProperties": true,
"properties": {
"installId": {
"type": "string"
}
},
"type": "object"
},
"JobTitle": {
"properties": {
"value": {
"type": "string"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"LanguagesSpoken": {
"properties": {
"value": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"LikeItemV2": {
"properties": {
"created": {
"type": "string"
},
"initiatedWith": {
"type": "string"
},
"playerId": {
"type": "string"
},
"rating": {
"$ref": "#/components/schemas/LikeRating"
},
"source": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"required": [
"playerId",
"subjectId",
"created",
"source",
"initiatedWith",
"rating"
],
"title": "LikeItemV2",
"type": "object"
},
"LikeLimit": {
"properties": {
"likes": {
"format": "int32",
"type": "integer"
},
"superlikes": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"required": [
"likes"
],
"title": "LikeLimit",
"type": "object"
},
"LikePromptPoll": {
"properties": {
"contentId": {
"type": [
"string",
"null"
]
},
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"questionId": {
"type": "string"
},
"selectedOption": {
"type": [
"string",
"null"
]
},
"selectedOptionIndex": {
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"required": [
"options",
"questionId"
],
"title": "LikePromptPoll",
"type": "object"
},
"LikeRating": {
"properties": {
"content": {
"default": [],
"items": {
"$ref": "#/components/schemas/LikeRatingContentItem"
},
"type": "array"
}
},
"title": "LikeRating",
"type": "object"
},
"LikeRatingContentItem": {
"properties": {
"comment": {
"default": null,
"type": [
"string",
"null"
]
},
"photo": {
"anyOf": [
{
"$ref": "#/components/schemas/PhotoAsset"
},
{
"type": "null"
}
],
"default": null
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/CreateRateContentPrompt"
},
{
"type": "null"
}
],
"default": null
},
"promptPoll": {
"anyOf": [
{
"$ref": "#/components/schemas/LikePromptPoll"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "LikeRatingContentItem",
"type": "object"
},
"LikeResponse": {
"properties": {
"limit": {
"$ref": "#/components/schemas/LikeLimit"
}
},
"required": [
"limit"
],
"title": "LikeResponse",
"type": "object"
},
"LikeSortV2": {
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
}
},
"required": [
"id",
"title"
],
"title": "LikeSortV2",
"type": "object"
},
"LikesV2Response": {
"properties": {
"hiddenLikes": {
"default": [],
"items": true,
"type": "array"
},
"likes": {
"items": {
"$ref": "#/components/schemas/LikeItemV2"
},
"type": "array"
},
"sortedLikes": {
"default": [],
"items": {
"$ref": "#/components/schemas/SortedLikesGroupV2"
},
"type": "array"
},
"sorts": {
"default": [],
"items": {
"$ref": "#/components/schemas/LikeSortV2"
},
"type": "array"
}
},
"required": [
"likes"
],
"title": "LikesV2Response",
"type": "object"
},
"Location": {
"properties": {
"adminArea1Long": {
"type": [
"string",
"null"
]
},
"adminArea1Short": {
"type": [
"string",
"null"
]
},
"adminArea2": {
"type": [
"string",
"null"
]
},
"countryShort": {
"type": [
"string",
"null"
]
},
"latitude": {
"format": "double",
"type": [
"number",
"null"
]
},
"longitude": {
"format": "double",
"type": [
"number",
"null"
]
},
"metroArea": {
"type": [
"string",
"null"
]
},
"metroAreaV2": {
"type": [
"string",
"null"
]
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"title": "Location",
"type": "object"
},
"LoginTokens": {
"properties": {
"hingeAuthToken": {
"anyOf": [
{
"$ref": "#/components/schemas/HingeAuthToken"
},
{
"type": "null"
}
],
"default": null
},
"sendbirdAuthToken": {
"anyOf": [
{
"$ref": "#/components/schemas/SendbirdAuthToken"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "LoginTokens",
"type": "object"
},
"MarijuanaStatus": {
"properties": {
"value": {
"$ref": "#/components/schemas/MarijuanaStatusProfile"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"MarijuanaStatusPreference": {
"enum": [
"OpenToAll",
"No",
"Yes",
"Sometimes",
"NoPreference"
],
"type": "string"
},
"MarijuanaStatusProfile": {
"enum": [
"PreferNotToSay",
"No",
"Yes",
"Sometimes",
"NoPreference"
],
"type": "string"
},
"MatchNoteResponse": {
"properties": {
"note": {
"type": "string"
}
},
"required": [
"note"
],
"title": "MatchNoteResponse",
"type": "object"
},
"MessageData": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"title": "MessageData",
"type": "object"
},
"NotificationSettings": {
"properties": {
"email": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
"push": {
"additionalProperties": {
"type": "boolean"
},
"type": "object"
}
},
"required": [
"email",
"push"
],
"title": "NotificationSettings",
"type": "object"
},
"OtpSubmitRequest": {
"additionalProperties": true,
"properties": {
"deviceId": {
"type": "string"
},
"installId": {
"type": "string"
},
"otp": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
},
"type": "object"
},
"PhotoAsset": {
"properties": {
"boundingBox": {
"anyOf": [
{
"$ref": "#/components/schemas/BoundingBox"
},
{
"type": "null"
}
]
},
"caption": {
"type": [
"string",
"null"
]
},
"cdnId": {
"type": [
"string",
"null"
]
},
"contentId": {
"type": [
"string",
"null"
]
},
"height": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"location": {
"type": [
"string",
"null"
]
},
"pHash": {
"type": [
"string",
"null"
]
},
"promptId": {
"type": [
"string",
"null"
]
},
"selfieVerified": {
"type": [
"boolean",
"null"
]
},
"source": {
"type": [
"string",
"null"
]
},
"sourceId": {
"type": [
"string",
"null"
]
},
"url": {
"type": "string"
},
"videoUrl": {
"type": [
"string",
"null"
]
},
"width": {
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"required": [
"url"
],
"title": "PhotoAsset",
"type": "object"
},
"PhotoAssetInput": {
"properties": {
"boundingBox": {
"anyOf": [
{
"$ref": "#/components/schemas/BoundingBox"
},
{
"type": "null"
}
]
},
"cdnId": {
"type": [
"string",
"null"
]
},
"contentId": {
"type": [
"string",
"null"
]
},
"selfieVerified": {
"type": [
"boolean",
"null"
]
},
"url": {
"type": "string"
}
},
"required": [
"url"
],
"title": "PhotoAssetInput",
"type": "object"
},
"Politics": {
"properties": {
"value": {
"$ref": "#/components/schemas/PoliticsProfile"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"PoliticsPreference": {
"enum": [
"OpenToAll",
"Liberal",
"Moderate",
"Conservative",
"NotPolitical",
"Other"
],
"type": "string"
},
"PoliticsProfile": {
"enum": [
"PreferNotToSay",
"Liberal",
"Moderate",
"Conservative",
"NotPolitical",
"Other"
],
"type": "string"
},
"Preferences": {
"properties": {
"children": {
"items": {
"$ref": "#/components/schemas/ChildrenStatusPreference"
},
"type": "array"
},
"datingIntentions": {
"items": {
"$ref": "#/components/schemas/DatingIntentionPreference"
},
"type": "array"
},
"dealbreakers": {
"$ref": "#/components/schemas/Dealbreakers"
},
"drinking": {
"items": {
"$ref": "#/components/schemas/DrinkingStatusPreference"
},
"type": "array"
},
"drugs": {
"items": {
"$ref": "#/components/schemas/DrugStatusPreference"
},
"type": "array"
},
"educationAttained": {
"items": {
"$ref": "#/components/schemas/EducationAttainedPreference"
},
"type": "array"
},
"ethnicities": {
"items": {
"$ref": "#/components/schemas/EthnicityPreference"
},
"type": "array"
},
"familyPlans": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"genderPreferences": {
"items": {
"$ref": "#/components/schemas/GenderPreferences"
},
"type": "array"
},
"genderedAgeRanges": {
"$ref": "#/components/schemas/GenderedRange"
},
"genderedHeightRanges": {
"$ref": "#/components/schemas/GenderedRange"
},
"marijuana": {
"items": {
"$ref": "#/components/schemas/MarijuanaStatusPreference"
},
"type": "array"
},
"maxDistance": {
"format": "int32",
"type": "integer"
},
"politics": {
"items": {
"$ref": "#/components/schemas/PoliticsPreference"
},
"type": "array"
},
"relationshipTypes": {
"items": {
"$ref": "#/components/schemas/RelationshipTypePreference"
},
"type": "array"
},
"religions": {
"items": {
"$ref": "#/components/schemas/ReligionPreference"
},
"type": "array"
},
"smoking": {
"items": {
"$ref": "#/components/schemas/SmokingStatusPreference"
},
"type": "array"
}
},
"required": [
"genderedAgeRanges",
"dealbreakers",
"religions",
"drinking",
"genderedHeightRanges",
"marijuana",
"relationshipTypes",
"drugs",
"maxDistance",
"children",
"ethnicities",
"smoking",
"educationAttained",
"familyPlans",
"datingIntentions",
"politics",
"genderPreferences"
],
"title": "Preferences",
"type": "object"
},
"PreferencesResponse": {
"properties": {
"children": {
"items": {
"$ref": "#/components/schemas/ChildrenStatusPreference"
},
"type": "array"
},
"datingIntentions": {
"items": {
"$ref": "#/components/schemas/DatingIntentionPreference"
},
"type": "array"
},
"dealbreakers": {
"$ref": "#/components/schemas/Dealbreakers"
},
"drinking": {
"items": {
"$ref": "#/components/schemas/DrinkingStatusPreference"
},
"type": "array"
},
"drugs": {
"items": {
"$ref": "#/components/schemas/DrugStatusPreference"
},
"type": "array"
},
"educationAttained": {
"items": {
"$ref": "#/components/schemas/EducationAttainedPreference"
},
"type": "array"
},
"ethnicities": {
"items": {
"$ref": "#/components/schemas/EthnicityPreference"
},
"type": "array"
},
"familyPlans": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"genderPreferences": {
"items": {
"$ref": "#/components/schemas/GenderPreferences"
},
"type": "array"
},
"genderedAgeRanges": {
"$ref": "#/components/schemas/GenderedRange"
},
"genderedHeightRanges": {
"$ref": "#/components/schemas/GenderedRange"
},
"marijuana": {
"items": {
"$ref": "#/components/schemas/MarijuanaStatusPreference"
},
"type": "array"
},
"maxDistance": {
"format": "int32",
"type": "integer"
},
"politics": {
"items": {
"$ref": "#/components/schemas/PoliticsPreference"
},
"type": "array"
},
"relationshipTypes": {
"items": {
"$ref": "#/components/schemas/RelationshipTypePreference"
},
"type": "array"
},
"religions": {
"items": {
"$ref": "#/components/schemas/ReligionPreference"
},
"type": "array"
},
"smoking": {
"items": {
"$ref": "#/components/schemas/SmokingStatusPreference"
},
"type": "array"
}
},
"required": [
"genderedAgeRanges",
"dealbreakers",
"religions",
"drinking",
"genderedHeightRanges",
"marijuana",
"relationshipTypes",
"drugs",
"maxDistance",
"children",
"ethnicities",
"smoking",
"educationAttained",
"familyPlans",
"datingIntentions",
"politics",
"genderPreferences"
],
"title": "PreferencesResponse",
"type": "object"
},
"PreferencesUpdateRequest": {
"items": {
"$ref": "#/components/schemas/Preferences"
},
"type": "array"
},
"Profile": {
"properties": {
"age": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"answers": {
"default": [],
"items": {
"$ref": "#/components/schemas/ProfileAnswer"
},
"type": "array"
},
"birthday": {
"type": [
"string",
"null"
]
},
"children": {
"anyOf": [
{
"$ref": "#/components/schemas/ChildrenStatus"
},
{
"type": "null"
}
]
},
"covidVax": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"datingIntention": {
"anyOf": [
{
"$ref": "#/components/schemas/DatingIntention"
},
{
"type": "null"
}
]
},
"datingIntentionText": {
"type": [
"string",
"null"
]
},
"didJustJoin": {
"type": [
"boolean",
"null"
]
},
"drinking": {
"anyOf": [
{
"$ref": "#/components/schemas/DrinkingStatus"
},
{
"type": "null"
}
]
},
"drugs": {
"anyOf": [
{
"$ref": "#/components/schemas/DrugStatus"
},
{
"type": "null"
}
]
},
"educationAttained": {
"anyOf": [
{
"$ref": "#/components/schemas/EducationAttainedProfile"
},
{
"type": "null"
}
]
},
"educations": {
"anyOf": [
{
"$ref": "#/components/schemas/Educations"
},
{
"type": "null"
}
]
},
"email": {
"type": [
"string",
"null"
]
},
"emailVerified": {
"type": [
"boolean",
"null"
]
},
"ethnicities": {
"anyOf": [
{
"$ref": "#/components/schemas/Ethnicities"
},
{
"type": "null"
}
]
},
"ethnicitiesText": {
"type": [
"string",
"null"
]
},
"familyPlans": {
"anyOf": [
{
"$ref": "#/components/schemas/FamilyPlans"
},
{
"type": "null"
}
]
},
"firstCompletedDate": {
"type": [
"string",
"null"
]
},
"firstName": {
"type": "string"
},
"genderId": {
"anyOf": [
{
"$ref": "#/components/schemas/GenderEnum"
},
{
"type": "null"
}
]
},
"genderIdentity": {
"type": [
"string",
"null"
]
},
"genderIdentityId": {
"anyOf": [
{
"$ref": "#/components/schemas/GenderIdentityId"
},
{
"type": "null"
}
]
},
"height": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"hometown": {
"anyOf": [
{
"$ref": "#/components/schemas/Hometown"
},
{
"type": "null"
}
]
},
"jobTitle": {
"anyOf": [
{
"$ref": "#/components/schemas/JobTitle"
},
{
"type": "null"
}
]
},
"languagesSpoken": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguagesSpoken"
},
{
"type": "null"
}
]
},
"lastActiveStatusId": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"lastName": {
"type": [
"string",
"null"
]
},
"location": {
"$ref": "#/components/schemas/Location"
},
"marijuana": {
"anyOf": [
{
"$ref": "#/components/schemas/MarijuanaStatus"
},
{
"type": "null"
}
]
},
"name": {
"anyOf": [
{
"$ref": "#/components/schemas/ProfileName"
},
{
"type": "null"
}
]
},
"pets": true,
"phone": {
"type": [
"string",
"null"
]
},
"photos": {
"default": [],
"items": {
"$ref": "#/components/schemas/PhotoAsset"
},
"type": "array"
},
"politics": {
"anyOf": [
{
"$ref": "#/components/schemas/Politics"
},
{
"type": "null"
}
]
},
"pronouns": {
"anyOf": [
{
"$ref": "#/components/schemas/Pronouns"
},
{
"type": "null"
}
]
},
"relationshipTypeIds": {
"anyOf": [
{
"$ref": "#/components/schemas/RelationshipTypeIds"
},
{
"type": "null"
}
]
},
"relationshipTypesText": {
"type": [
"string",
"null"
]
},
"religions": {
"anyOf": [
{
"$ref": "#/components/schemas/Religion"
},
{
"type": "null"
}
]
},
"selfieVerified": {
"type": [
"boolean",
"null"
]
},
"sexualOrientations": {
"anyOf": [
{
"$ref": "#/components/schemas/SexualOrientations"
},
{
"type": "null"
}
]
},
"smoking": {
"anyOf": [
{
"$ref": "#/components/schemas/SmokingStatus"
},
{
"type": "null"
}
]
},
"works": {
"anyOf": [
{
"$ref": "#/components/schemas/Works"
},
{
"type": "null"
}
]
},
"zodiac": {
"anyOf": [
{
"$ref": "#/components/schemas/Zodiac"
},
{
"type": "null"
}
]
}
},
"required": [
"firstName",
"location"
],
"title": "Profile",
"type": "object"
},
"ProfileAnswer": {
"properties": {
"cdnId": {
"type": [
"string",
"null"
]
},
"content": {
"type": [
"string",
"null"
]
},
"contentId": {
"type": [
"string",
"null"
]
},
"feedback": {
"anyOf": [
{
"$ref": "#/components/schemas/Feedback"
},
{
"type": "null"
}
]
},
"position": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"promptId": {
"type": [
"string",
"null"
]
},
"questionId": {
"type": [
"string",
"null"
]
},
"response": {
"type": [
"string",
"null"
]
},
"transcription": {
"type": [
"string",
"null"
]
},
"transcriptionMetadata": true,
"type": {
"type": [
"string",
"null"
]
},
"url": {
"type": [
"string",
"null"
]
},
"waveform": {
"type": [
"string",
"null"
]
}
},
"title": "ProfileAnswer",
"type": "object"
},
"ProfileContent": {
"properties": {
"answers": {
"default": [],
"items": {
"$ref": "#/components/schemas/ProfileAnswer"
},
"type": "array"
},
"name": {
"$ref": "#/components/schemas/ProfileName"
},
"photos": {
"default": [],
"items": {
"$ref": "#/components/schemas/PhotoAsset"
},
"type": "array"
}
},
"required": [
"name"
],
"title": "ProfileContent",
"type": "object"
},
"ProfileContentContent": {
"properties": {
"answers": {
"items": {
"$ref": "#/components/schemas/ProfileAnswer"
},
"type": "array"
},
"photos": {
"items": {
"$ref": "#/components/schemas/PhotoAsset"
},
"type": "array"
},
"promptPoll": {
"anyOf": [
{
"$ref": "#/components/schemas/PromptPoll"
},
{
"type": "null"
}
],
"default": null
},
"videoPrompt": {
"anyOf": [
{
"$ref": "#/components/schemas/VideoPrompt"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"photos",
"answers"
],
"title": "ProfileContentContent",
"type": "object"
},
"ProfileContentFull": {
"properties": {
"content": {
"$ref": "#/components/schemas/ProfileContentContent"
},
"userId": {
"type": "string"
}
},
"required": [
"userId",
"content"
],
"title": "ProfileContentFull",
"type": "object"
},
"ProfileName": {
"properties": {
"firstName": {
"type": "string"
},
"lastName": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"firstName"
],
"title": "ProfileName",
"type": "object"
},
"ProfileUpdate": {
"properties": {
"children": {
"anyOf": [
{
"$ref": "#/components/schemas/ChildrenStatus"
},
{
"type": "null"
}
]
},
"datingIntention": {
"anyOf": [
{
"$ref": "#/components/schemas/DatingIntention"
},
{
"type": "null"
}
]
},
"drinking": {
"anyOf": [
{
"$ref": "#/components/schemas/DrinkingStatus"
},
{
"type": "null"
}
]
},
"drugs": {
"anyOf": [
{
"$ref": "#/components/schemas/DrugStatus"
},
{
"type": "null"
}
]
},
"educationAttained": {
"anyOf": [
{
"$ref": "#/components/schemas/EducationAttainedProfile"
},
{
"type": "null"
}
]
},
"ethnicities": {
"anyOf": [
{
"$ref": "#/components/schemas/Ethnicities"
},
{
"type": "null"
}
]
},
"genderId": {
"anyOf": [
{
"$ref": "#/components/schemas/GenderEnum"
},
{
"type": "null"
}
]
},
"height": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"hometown": {
"anyOf": [
{
"$ref": "#/components/schemas/Hometown"
},
{
"type": "null"
}
]
},
"languagesSpoken": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguagesSpoken"
},
{
"type": "null"
}
]
},
"marijuana": {
"anyOf": [
{
"$ref": "#/components/schemas/MarijuanaStatus"
},
{
"type": "null"
}
]
},
"politics": {
"anyOf": [
{
"$ref": "#/components/schemas/Politics"
},
{
"type": "null"
}
]
},
"relationshipTypeIds": {
"anyOf": [
{
"$ref": "#/components/schemas/RelationshipTypeIds"
},
{
"type": "null"
}
]
},
"religions": {
"anyOf": [
{
"$ref": "#/components/schemas/Religion"
},
{
"type": "null"
}
]
},
"smoking": {
"anyOf": [
{
"$ref": "#/components/schemas/SmokingStatus"
},
{
"type": "null"
}
]
},
"zodiac": {
"anyOf": [
{
"$ref": "#/components/schemas/Zodiac"
},
{
"type": "null"
}
]
}
},
"title": "ProfileUpdate",
"type": "object"
},
"ProfileUpdateRequest": {
"properties": {
"children": {
"anyOf": [
{
"$ref": "#/components/schemas/ChildrenStatus"
},
{
"type": "null"
}
]
},
"datingIntention": {
"anyOf": [
{
"$ref": "#/components/schemas/DatingIntention"
},
{
"type": "null"
}
]
},
"drinking": {
"anyOf": [
{
"$ref": "#/components/schemas/DrinkingStatus"
},
{
"type": "null"
}
]
},
"drugs": {
"anyOf": [
{
"$ref": "#/components/schemas/DrugStatus"
},
{
"type": "null"
}
]
},
"educationAttained": {
"anyOf": [
{
"$ref": "#/components/schemas/EducationAttainedProfile"
},
{
"type": "null"
}
]
},
"ethnicities": {
"anyOf": [
{
"$ref": "#/components/schemas/Ethnicities"
},
{
"type": "null"
}
]
},
"genderId": {
"anyOf": [
{
"$ref": "#/components/schemas/GenderEnum"
},
{
"type": "null"
}
]
},
"height": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"hometown": {
"anyOf": [
{
"$ref": "#/components/schemas/Hometown"
},
{
"type": "null"
}
]
},
"languagesSpoken": {
"anyOf": [
{
"$ref": "#/components/schemas/LanguagesSpoken"
},
{
"type": "null"
}
]
},
"marijuana": {
"anyOf": [
{
"$ref": "#/components/schemas/MarijuanaStatus"
},
{
"type": "null"
}
]
},
"politics": {
"anyOf": [
{
"$ref": "#/components/schemas/Politics"
},
{
"type": "null"
}
]
},
"relationshipTypeIds": {
"anyOf": [
{
"$ref": "#/components/schemas/RelationshipTypeIds"
},
{
"type": "null"
}
]
},
"religions": {
"anyOf": [
{
"$ref": "#/components/schemas/Religion"
},
{
"type": "null"
}
]
},
"smoking": {
"anyOf": [
{
"$ref": "#/components/schemas/SmokingStatus"
},
{
"type": "null"
}
]
},
"zodiac": {
"anyOf": [
{
"$ref": "#/components/schemas/Zodiac"
},
{
"type": "null"
}
]
}
},
"title": "ProfileUpdate",
"type": "object"
},
"Prompt": {
"properties": {
"categories": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"contentTypes": {
"default": [],
"items": {
"$ref": "#/components/schemas/ContentType"
},
"type": "array"
},
"id": {
"type": "string"
},
"isNew": {
"type": "boolean"
},
"isSelectable": {
"type": "boolean"
},
"placeholder": {
"default": "",
"type": "string"
},
"prompt": {
"type": "string"
}
},
"required": [
"id",
"prompt",
"isSelectable",
"isNew"
],
"title": "Prompt",
"type": "object"
},
"PromptCategory": {
"properties": {
"isNew": {
"type": "boolean"
},
"isVisible": {
"type": "boolean"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
}
},
"required": [
"name",
"slug",
"isVisible",
"isNew"
],
"title": "PromptCategory",
"type": "object"
},
"PromptPayload": {
"additionalProperties": true,
"description": "Prompt catalog request generated from profile and preferences.",
"type": "object"
},
"PromptPoll": {
"properties": {
"contentId": {
"type": "string"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"questionId": {
"type": "string"
}
},
"required": [
"contentId",
"questionId",
"options"
],
"title": "PromptPoll",
"type": "object"
},
"PromptsResponse": {
"properties": {
"categories": {
"items": {
"$ref": "#/components/schemas/PromptCategory"
},
"type": "array"
},
"prompts": {
"items": {
"$ref": "#/components/schemas/Prompt"
},
"type": "array"
}
},
"required": [
"prompts",
"categories"
],
"title": "PromptsResponse",
"type": "object"
},
"Pronouns": {
"properties": {
"value": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"PublicContentResponse": {
"items": {
"$ref": "#/components/schemas/ProfileContentFull"
},
"type": "array"
},
"PublicProfile": {
"properties": {
"age": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"birthday": {
"type": [
"string",
"null"
]
},
"children": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"covidVax": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"datingIntention": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"datingIntentionText": {
"type": [
"string",
"null"
]
},
"didJustJoin": {
"type": [
"boolean",
"null"
]
},
"drinking": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"drugs": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"educationAttained": {
"anyOf": [
{
"$ref": "#/components/schemas/EducationAttainedProfile"
},
{
"type": "null"
}
]
},
"educations": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"emailVerified": {
"type": [
"boolean",
"null"
]
},
"ethnicities": {
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"ethnicitiesText": {
"type": [
"string",
"null"
]
},
"familyPlans": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"firstCompletedDate": {
"type": [
"string",
"null"
]
},
"firstName": {
"type": "string"
},
"genderId": {
"anyOf": [
{
"$ref": "#/components/schemas/GenderEnum"
},
{
"type": "null"
}
]
},
"genderIdentity": {
"type": [
"string",
"null"
]
},
"genderIdentityId": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"height": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"hometown": {
"type": [
"string",
"null"
]
},
"jobTitle": {
"type": [
"string",
"null"
]
},
"languagesSpoken": {
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"lastActiveStatusId": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"lastName": {
"type": [
"string",
"null"
]
},
"location": {
"$ref": "#/components/schemas/Location"
},
"marijuana": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"pets": {
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"phone": {
"type": [
"string",
"null"
]
},
"politics": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"pronouns": {
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"relationshipTypeIds": {
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"relationshipTypesText": {
"type": [
"string",
"null"
]
},
"religions": {
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"selfieVerified": {
"type": [
"boolean",
"null"
]
},
"sexualOrientations": {
"items": {
"format": "int32",
"type": "integer"
},
"type": [
"array",
"null"
]
},
"smoking": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"works": {
"type": [
"string",
"null"
]
},
"zodiac": {
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"required": [
"firstName",
"location"
],
"title": "PublicProfile",
"type": "object"
},
"PublicProfilesResponse": {
"items": {
"$ref": "#/components/schemas/PublicUserProfile"
},
"type": "array"
},
"PublicUserProfile": {
"properties": {
"profile": {
"$ref": "#/components/schemas/PublicProfile"
},
"userId": {
"type": "string"
}
},
"required": [
"userId",
"profile"
],
"title": "PublicUserProfile",
"type": "object"
},
"RangeDetails": {
"properties": {
"max": {
"format": "int32",
"type": [
"integer",
"null"
]
},
"min": {
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"title": "RangeDetails",
"type": "object"
},
"RateContentPayload": {
"properties": {
"comment": {
"type": [
"string",
"null"
]
},
"photo": true,
"prompt": true
},
"title": "RateContentPayload",
"type": "object"
},
"RateInput": {
"properties": {
"answerText": {
"default": null,
"type": [
"string",
"null"
]
},
"comment": {
"default": null,
"type": [
"string",
"null"
]
},
"contentId": {
"default": null,
"type": [
"string",
"null"
]
},
"origin": {
"default": null,
"type": [
"string",
"null"
]
},
"photo": {
"anyOf": [
{
"$ref": "#/components/schemas/PhotoAssetInput"
},
{
"type": "null"
}
],
"default": null
},
"questionText": {
"default": null,
"type": [
"string",
"null"
]
},
"ratingToken": {
"type": "string"
},
"subjectId": {
"type": "string"
},
"useSuperlike": {
"default": null,
"type": [
"boolean",
"null"
]
}
},
"required": [
"subjectId",
"ratingToken"
],
"title": "RateInput",
"type": "object"
},
"RatePayload": {
"properties": {
"content": {
"anyOf": [
{
"$ref": "#/components/schemas/RateContentPayload"
},
{
"type": "null"
}
]
},
"created": {
"type": "string"
},
"hasPairing": {
"type": "boolean"
},
"initiatedWith": {
"type": "string"
},
"origin": {
"type": "string"
},
"rating": {
"type": "string"
},
"ratingId": {
"type": "string"
},
"ratingToken": {
"type": "string"
},
"sessionId": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"required": [
"ratingId",
"ratingToken",
"subjectId",
"sessionId",
"rating",
"origin",
"hasPairing",
"created",
"initiatedWith"
],
"title": "RatePayload",
"type": "object"
},
"RateRespondRequest": {
"properties": {
"created": {
"type": [
"string",
"null"
]
},
"initiatedWith": {
"type": [
"string",
"null"
]
},
"origin": {
"type": "string"
},
"rating": {
"type": "string"
},
"ratingId": {
"type": [
"string",
"null"
]
},
"sessionId": {
"type": [
"string",
"null"
]
},
"sortType": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"required": [
"sortType",
"subjectId",
"origin",
"rating"
],
"title": "RateRespondRequest",
"type": "object"
},
"RateRespondResponse": {
"properties": {
"limit": {
"anyOf": [
{
"$ref": "#/components/schemas/LikeLimit"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "RateRespondResponse",
"type": "object"
},
"RawJson": {
"additionalProperties": true,
"description": "Raw JSON object retained as an explicit escape hatch for undocumented response drift.",
"type": "object"
},
"RecommendationSubject": {
"properties": {
"origin": {
"default": null,
"type": [
"string",
"null"
]
},
"ratingToken": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"required": [
"subjectId",
"ratingToken"
],
"title": "RecommendationSubject",
"type": "object"
},
"RecommendationsFeed": {
"properties": {
"id": {
"format": "int32",
"type": "integer"
},
"origin": {
"type": "string"
},
"permission": {
"default": null,
"type": [
"string",
"null"
]
},
"preview": {
"anyOf": [
{
"$ref": "#/components/schemas/RecommendationsPreview"
},
{
"type": "null"
}
],
"default": null
},
"subjects": {
"items": {
"$ref": "#/components/schemas/RecommendationSubject"
},
"type": "array"
}
},
"required": [
"id",
"origin",
"subjects"
],
"title": "RecommendationsFeed",
"type": "object"
},
"RecommendationsPreview": {
"properties": {
"permission": {
"type": "string"
},
"subjects": {
"items": {
"$ref": "#/components/schemas/RecommendationSubject"
},
"type": "array"
}
},
"required": [
"subjects",
"permission"
],
"title": "RecommendationsPreview",
"type": "object"
},
"RecommendationsRequest": {
"additionalProperties": true,
"properties": {
"activeToday": {
"type": "boolean"
},
"newHere": {
"type": "boolean"
},
"playerId": {
"type": "string"
}
},
"type": "object"
},
"RecommendationsResponse": {
"properties": {
"activePills": {
"default": null,
"items": {
"$ref": "#/components/schemas/ActivePill"
},
"type": [
"array",
"null"
]
},
"cacheControl": {
"default": null
},
"feeds": {
"items": {
"$ref": "#/components/schemas/RecommendationsFeed"
},
"type": "array"
}
},
"required": [
"feeds"
],
"title": "RecommendationsResponse",
"type": "object"
},
"RecsV2Params": {
"properties": {
"activeToday": {
"default": false,
"type": "boolean"
},
"newHere": {
"default": false,
"type": "boolean"
}
},
"title": "RecsV2Params",
"type": "object"
},
"RelationshipTypeIds": {
"properties": {
"value": {
"items": {
"$ref": "#/components/schemas/RelationshipTypeProfile"
},
"type": "array"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"RelationshipTypePreference": {
"enum": [
"OpenToAll",
"Monogamy",
"EthicalNonMonogamy",
"FiguringOutTheirRelationshipType"
],
"type": "string"
},
"RelationshipTypeProfile": {
"enum": [
"PreferNotToSay",
"Monogamy",
"EthicalNonMonogamy",
"FiguringOutTheirRelationshipType"
],
"type": "string"
},
"Religion": {
"properties": {
"value": {
"items": {
"$ref": "#/components/schemas/ReligionProfile"
},
"type": "array"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"ReligionPreference": {
"enum": [
"OpenToAll",
"Spiritual",
"Catholic",
"Christian",
"Hindu",
"Jewish",
"Muslim",
"Buddhist",
"Agnostic",
"Atheist",
"Other",
"Sikh"
],
"type": "string"
},
"ReligionProfile": {
"enum": [
"PreferNotToSay",
"Spiritual",
"Catholic",
"Christian",
"Hindu",
"Jewish",
"Muslim",
"Buddhist",
"Agnostic",
"Atheist",
"Other",
"Sikh"
],
"type": "string"
},
"SelfContentResponse": {
"properties": {
"content": {
"$ref": "#/components/schemas/ContentData"
}
},
"required": [
"content"
],
"title": "SelfContentResponse",
"type": "object"
},
"SelfProfileResponse": {
"properties": {
"created": {
"type": "string"
},
"lastActiveOptIn": {
"type": "boolean"
},
"modified": {
"type": "string"
},
"paused": {
"type": "boolean"
},
"profile": {
"$ref": "#/components/schemas/Profile"
},
"registered": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"userId",
"created",
"registered",
"modified",
"lastActiveOptIn",
"profile",
"paused"
],
"title": "SelfProfileResponse",
"type": "object"
},
"SendMessagePayload": {
"properties": {
"ays": {
"type": "boolean"
},
"dedupId": {
"type": [
"string",
"null"
]
},
"matchMessage": {
"type": "boolean"
},
"messageData": {
"$ref": "#/components/schemas/MessageData"
},
"messageType": {
"type": "string"
},
"origin": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"required": [
"ays",
"matchMessage",
"messageType",
"messageData",
"subjectId",
"origin"
],
"title": "SendMessagePayload",
"type": "object"
},
"SendbirdAuthToken": {
"properties": {
"expires": {
"format": "date-time",
"type": "string"
},
"token": {
"type": "string"
}
},
"required": [
"token",
"expires"
],
"title": "SendbirdAuthToken",
"type": "object"
},
"SendbirdAuthenticateRequest": {
"additionalProperties": true,
"properties": {
"refresh": {
"type": "boolean"
}
},
"type": "object"
},
"SendbirdChannelHandle": {
"properties": {
"channelUrl": {
"type": "string"
}
},
"required": [
"channelUrl"
],
"title": "SendbirdChannelHandle",
"type": "object"
},
"SendbirdChannelMember": {
"properties": {
"is_active": {
"default": false,
"type": "boolean"
},
"metadata": {
"default": null
},
"nickname": {
"default": "",
"type": "string"
},
"profile_url": {
"default": "",
"type": "string"
},
"user_id": {
"default": "",
"type": "string"
}
},
"title": "SendbirdChannelMember",
"type": "object"
},
"SendbirdChannelsInput": {
"properties": {
"limit": {
"default": null,
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"title": "SendbirdChannelsInput",
"type": "object"
},
"SendbirdChannelsResponse": {
"properties": {
"channels": {
"default": [],
"items": {
"$ref": "#/components/schemas/SendbirdGroupChannel"
},
"type": "array"
}
},
"title": "SendbirdChannelsResponse",
"type": "object"
},
"SendbirdCloseRequest": {
"properties": {
"code": {
"default": null,
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"reason": {
"default": null,
"type": [
"string",
"null"
]
}
},
"title": "SendbirdCloseRequest",
"type": "object"
},
"SendbirdCreateChannelRequest": {
"additionalProperties": true,
"description": "Sendbird distinct group channel creation request.",
"type": "object"
},
"SendbirdGetMessagesInput": {
"properties": {
"channelUrl": {
"type": "string"
},
"messageTs": {
"type": "string"
},
"prevLimit": {
"format": "int32",
"type": "integer"
}
},
"required": [
"channelUrl",
"messageTs",
"prevLimit"
],
"title": "SendbirdGetMessagesInput",
"type": "object"
},
"SendbirdGroupChannel": {
"properties": {
"channel_url": {
"type": "string"
},
"cover_url": {
"default": "",
"type": "string"
},
"created_at": {
"default": "",
"type": "string"
},
"custom_type": {
"default": "",
"type": "string"
},
"joined_member_count": {
"default": 0,
"format": "int32",
"type": "integer"
},
"last_message": {
"anyOf": [
{
"$ref": "#/components/schemas/SendbirdMessage"
},
{
"type": "null"
}
],
"default": null
},
"member_count": {
"default": 0,
"format": "int32",
"type": "integer"
},
"members": {
"default": [],
"items": {
"$ref": "#/components/schemas/SendbirdChannelMember"
},
"type": "array"
},
"metadata": {
"default": null
},
"my_member_state": {
"default": "",
"type": "string"
},
"name": {
"default": "",
"type": "string"
},
"unread_message_count": {
"default": 0,
"format": "int32",
"type": "integer"
},
"updated_at": {
"default": "",
"type": "string"
}
},
"required": [
"channel_url"
],
"title": "SendbirdGroupChannel",
"type": "object"
},
"SendbirdMessage": {
"properties": {
"channel_type": {
"default": "",
"type": "string"
},
"channel_url": {
"type": "string"
},
"created_at": {
"type": "string"
},
"custom_type": {
"default": "",
"type": "string"
},
"data": {
"default": "",
"type": "string"
},
"file": {
"default": null
},
"is_op_msg": {
"default": false,
"type": "boolean"
},
"is_removed": {
"default": false,
"type": "boolean"
},
"mention_type": {
"default": "",
"type": "string"
},
"mentioned_users": {
"default": [],
"items": true,
"type": "array"
},
"message": {
"default": "",
"type": "string"
},
"message_events": {
"default": null
},
"message_id": {
"type": "string"
},
"message_retention_hour": {
"default": "",
"type": "string"
},
"message_survival_seconds": {
"default": "",
"type": "string"
},
"reactions_summary": {
"default": [],
"items": true,
"type": "array"
},
"silent": {
"default": false,
"type": "boolean"
},
"sorted_metaarray": {
"default": [],
"items": {
"$ref": "#/components/schemas/SendbirdMessageMetaItem"
},
"type": "array"
},
"translations": {
"default": null
},
"type": {
"type": "string"
},
"updated_at": {
"default": "",
"type": "string"
},
"user": {
"$ref": "#/components/schemas/SendbirdMessageUser"
}
},
"required": [
"type",
"message_id",
"created_at",
"user",
"channel_url"
],
"title": "SendbirdMessage",
"type": "object"
},
"SendbirdMessageMetaItem": {
"properties": {
"key": {
"type": "string"
},
"value": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"key",
"value"
],
"title": "SendbirdMessageMetaItem",
"type": "object"
},
"SendbirdMessageUser": {
"properties": {
"is_active": {
"default": false,
"type": "boolean"
},
"is_blocked_by_me": {
"default": false,
"type": "boolean"
},
"metadata": {
"default": null
},
"nickname": {
"default": "",
"type": "string"
},
"profile_url": {
"default": "",
"type": "string"
},
"require_auth_for_profile_image": {
"default": false,
"type": "boolean"
},
"role": {
"default": "",
"type": "string"
},
"user_id": {
"type": "string"
}
},
"required": [
"user_id"
],
"title": "SendbirdMessageUser",
"type": "object"
},
"SendbirdMessagesResponse": {
"properties": {
"messages": {
"items": {
"$ref": "#/components/schemas/SendbirdMessage"
},
"type": "array"
}
},
"required": [
"messages"
],
"title": "SendbirdMessagesResponse",
"type": "object"
},
"SendbirdReadResponse": {
"properties": {
"channel_id": {
"type": "string"
},
"channel_type": {
"type": "string"
},
"channel_url": {
"type": "string"
},
"is_super": {
"type": "boolean"
},
"req_id": {
"type": "string"
},
"sts": {
"type": "string"
},
"target_parent_message_id": {
"type": [
"string",
"null"
]
},
"ts": {
"type": "string"
},
"user": {
"$ref": "#/components/schemas/SendbirdReadUser"
}
},
"required": [
"channel_id",
"user",
"ts",
"sts",
"channel_url",
"channel_type",
"is_super",
"req_id"
],
"title": "SendbirdReadResponse",
"type": "object"
},
"SendbirdReadUser": {
"properties": {
"guest_id": {
"type": "string"
},
"id": {
"type": "string"
},
"image": {
"type": "string"
},
"is_active": {
"type": "boolean"
},
"is_ai_bot": {
"type": "boolean"
},
"is_bot": {
"type": "boolean"
},
"metadata": {
"default": null
},
"name": {
"type": "string"
},
"require_auth_for_profile_image": {
"type": "boolean"
},
"role": {
"type": "string"
}
},
"required": [
"name",
"image",
"require_auth_for_profile_image",
"guest_id",
"id",
"role",
"is_bot",
"is_ai_bot",
"is_active"
],
"title": "SendbirdReadUser",
"type": "object"
},
"SendbirdSyevEvent": {
"properties": {
"cat": {
"format": "int32",
"type": "integer"
},
"channel_id": {
"default": null,
"type": [
"string",
"null"
]
},
"channel_type": {
"type": "string"
},
"channel_url": {
"type": "string"
},
"data": {
"anyOf": [
{
"$ref": "#/components/schemas/SendbirdSyevUserData"
},
{
"type": "null"
}
],
"default": null
},
"has_ai_bot": {
"default": false,
"type": "boolean"
},
"has_bot": {
"default": false,
"type": "boolean"
},
"is_access_code_required": {
"default": false,
"type": "boolean"
},
"is_super": {
"default": false,
"type": "boolean"
},
"sts": {
"default": "",
"type": "string"
},
"ts": {
"default": "",
"type": "string"
}
},
"required": [
"cat",
"channel_url",
"channel_type"
],
"title": "SendbirdSyevEvent",
"type": "object"
},
"SendbirdSyevUserData": {
"properties": {
"metadata": {
"default": null
},
"nickname": {
"default": "",
"type": "string"
},
"profile_url": {
"default": "",
"type": "string"
},
"require_auth_for_profile_image": {
"default": false,
"type": "boolean"
},
"user_id": {
"type": "string"
}
},
"required": [
"user_id"
],
"title": "SendbirdSyevUserData",
"type": "object"
},
"SendbirdWsEvent": {
"oneOf": [
{
"properties": {
"key": {
"type": "string"
},
"kind": {
"const": "sessionKey",
"type": "string"
}
},
"required": [
"kind",
"key"
],
"type": "object"
},
{
"properties": {
"kind": {
"const": "read",
"type": "string"
},
"payload": true,
"req_id": {
"default": null,
"type": [
"string",
"null"
]
}
},
"required": [
"kind",
"payload"
],
"type": "object"
},
{
"properties": {
"event": {
"$ref": "#/components/schemas/SendbirdSyevEvent"
},
"kind": {
"const": "typing",
"type": "string"
}
},
"required": [
"kind",
"event"
],
"type": "object"
},
{
"properties": {
"kind": {
"const": "ping",
"type": "string"
},
"payload": true
},
"required": [
"kind",
"payload"
],
"type": "object"
},
{
"properties": {
"kind": {
"const": "pong",
"type": "string"
},
"payload": true
},
"required": [
"kind",
"payload"
],
"type": "object"
},
{
"properties": {
"code": {
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"type": [
"integer",
"null"
]
},
"kind": {
"const": "close",
"type": "string"
},
"reason": {
"type": [
"string",
"null"
]
}
},
"required": [
"kind"
],
"type": "object"
},
{
"properties": {
"frame": {
"type": "string"
},
"kind": {
"const": "raw",
"type": "string"
}
},
"required": [
"kind",
"frame"
],
"type": "object"
}
],
"title": "SendbirdWsEvent"
},
"SexualOrientations": {
"properties": {
"value": {
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"SkipInput": {
"properties": {
"origin": {
"default": null,
"type": [
"string",
"null"
]
},
"ratingToken": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"required": [
"subjectId",
"ratingToken"
],
"title": "SkipInput",
"type": "object"
},
"SmokingStatus": {
"properties": {
"value": {
"$ref": "#/components/schemas/SmokingStatusProfile"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"SmokingStatusPreference": {
"enum": [
"OpenToAll",
"No",
"Yes",
"Sometimes"
],
"type": "string"
},
"SmokingStatusProfile": {
"enum": [
"PreferNotToSay",
"No",
"Yes",
"Sometimes"
],
"type": "string"
},
"SmsInitiateRequest": {
"additionalProperties": true,
"properties": {
"deviceId": {
"type": "string"
},
"phoneNumber": {
"type": "string"
}
},
"type": "object"
},
"SortedLikeIdV2": {
"properties": {
"id": {
"type": "string"
}
},
"required": [
"id"
],
"title": "SortedLikeIdV2",
"type": "object"
},
"SortedLikesGroupV2": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/SortedLikeIdV2"
},
"type": "array"
},
"sortID": {
"type": "string"
}
},
"required": [
"sortID",
"data"
],
"title": "SortedLikesGroupV2",
"type": "object"
},
"StandoutContent": {
"properties": {
"photo": {
"anyOf": [
{
"$ref": "#/components/schemas/StandoutMediaRef"
},
{
"type": "null"
}
],
"default": null
},
"prompt": {
"anyOf": [
{
"$ref": "#/components/schemas/StandoutMediaRef"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "StandoutContent",
"type": "object"
},
"StandoutItem": {
"properties": {
"content": {
"$ref": "#/components/schemas/StandoutContent"
},
"ratingToken": {
"type": "string"
},
"subjectId": {
"type": "string"
}
},
"required": [
"subjectId",
"ratingToken",
"content"
],
"title": "StandoutItem",
"type": "object"
},
"StandoutMediaRef": {
"properties": {
"contentId": {
"type": "string"
}
},
"required": [
"contentId"
],
"title": "StandoutMediaRef",
"type": "object"
},
"StandoutsResponse": {
"properties": {
"expiration": {
"default": null,
"type": [
"string",
"null"
]
},
"standouts": {
"default": [],
"items": {
"$ref": "#/components/schemas/StandoutItem"
},
"type": "array"
},
"status": {
"type": "string"
}
},
"required": [
"status"
],
"title": "StandoutsResponse",
"type": "object"
},
"TextReviewRequest": {
"additionalProperties": true,
"properties": {
"receiverId": {
"type": "string"
},
"text": {
"type": "string"
}
},
"type": "object"
},
"TextReviewResponse": {
"additionalProperties": true,
"properties": {
"hcmRunId": {
"type": "string"
}
},
"type": "object"
},
"UserProfile": {
"properties": {
"profile": true,
"userId": {
"type": "string"
}
},
"required": [
"userId",
"profile"
],
"title": "UserProfile",
"type": "object"
},
"UserSettings": {
"properties": {
"isSmartPhotoOptIn": {
"type": "boolean"
}
},
"required": [
"isSmartPhotoOptIn"
],
"title": "UserSettings",
"type": "object"
},
"UserTrait": {
"properties": {
"id": {
"type": "string"
},
"userInput": {
"type": "string"
}
},
"required": [
"id",
"userInput"
],
"title": "UserTrait",
"type": "object"
},
"UserTraitsResponse": {
"items": {
"$ref": "#/components/schemas/UserTrait"
},
"type": "array"
},
"VideoPrompt": {
"properties": {
"boundingBox": {
"$ref": "#/components/schemas/BoundingBox"
},
"cdnId": {
"type": "string"
},
"contentId": {
"type": "string"
},
"questionId": {
"type": "string"
},
"thumbnailUrl": {
"type": "string"
},
"videoUrl": {
"type": "string"
}
},
"required": [
"contentId",
"questionId",
"thumbnailUrl",
"videoUrl",
"cdnId",
"boundingBox"
],
"title": "VideoPrompt",
"type": "object"
},
"VoiceAnswerPayload": {
"properties": {
"cdnId": {
"type": "string"
},
"cdnUrl": {
"type": "string"
},
"type": {
"type": "string"
},
"url": {
"type": "string"
},
"waveform": {
"type": "string"
}
},
"required": [
"cdnUrl",
"waveform",
"type",
"cdnId",
"url"
],
"title": "VoiceAnswerPayload",
"type": "object"
},
"Works": {
"properties": {
"value": {
"type": "string"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
},
"Zodiac": {
"properties": {
"value": {
"format": "int32",
"type": "integer"
},
"visible": {
"type": "boolean"
}
},
"required": [
"value",
"visible"
],
"type": "object"
}
},
"securitySchemes": {
"bearerAuth": {
"bearerFormat": "JWT",
"scheme": "bearer",
"type": "http"
},
"sendbirdSessionKey": {
"in": "header",
"name": "Session-Key",
"type": "apiKey"
},
"sendbirdWsAuth": {
"in": "header",
"name": "SENDBIRD-WS-AUTH",
"type": "apiKey"
}
}
},
"info": {
"description": "Unofficial typed Hinge REST and Sendbird chat API surface generated from hinge-rs.",
"license": {
"identifier": "MIT OR Apache-2.0",
"name": "MIT OR Apache-2.0"
},
"title": "hinge-rs",
"version": "0.1.1",
"x-scalar-sdk-installation": [
{
"description": "Install the typed Rust client from crates.io:",
"lang": "Rust",
"source": "cargo add hinge-rs"
}
]
},
"openapi": "3.1.0",
"paths": {
"/auth/device/validate": {
"post": {
"description": "Completes the email-device validation flow when OTP returns email 2FA.",
"operationId": "submitEmail2faCode",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailCodeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginTokens"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [],
"summary": "Submit email 2FA code",
"tags": [
"Auth"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\n\nlet tokens = client\n .auth()\n .submit_email_code(\"case-id\", \"123456\")\n .await?;\nclient.persistence().save_session(\"session.json\")?;"
}
]
}
},
"/auth/settings": {
"get": {
"description": "Fetches auth settings.",
"operationId": "getAuthSettings",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthSettings"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get auth settings",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet settings = client.settings().auth().await?;"
}
]
}
},
"/auth/sms/v2": {
"post": {
"description": "Exchanges a phone number and OTP for Hinge and Sendbird tokens. A 412 response means email 2FA is required.",
"operationId": "submitSmsOtp",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"request": {
"value": {
"deviceId": "00000000-0000-0000-0000-000000000000",
"installId": "00000000-0000-0000-0000-000000000000",
"otp": "123456",
"phoneNumber": "+15555550123"
}
}
},
"schema": {
"$ref": "#/components/schemas/OtpSubmitRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"hingeAuthToken": {
"expires": "2026-04-26T00:00:00Z",
"identityId": "user_123",
"token": "[redacted]"
},
"sendbirdAuthToken": {
"expires": "2026-04-26T00:00:00Z",
"token": "[redacted]"
}
}
}
},
"schema": {
"$ref": "#/components/schemas/LoginTokens"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [],
"summary": "Submit SMS OTP",
"tags": [
"Auth"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\n\nlet tokens = client.auth().submit_otp(\"123456\").await?;\nclient.persistence().save_session(\"session.json\")?;"
}
]
}
},
"/auth/sms/v2/initiate": {
"post": {
"description": "Starts the SMS OTP login flow for a phone number.",
"operationId": "initiateSmsLogin",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"request": {
"value": {
"deviceId": "00000000-0000-0000-0000-000000000000",
"phoneNumber": "+15555550123"
}
}
},
"schema": {
"$ref": "#/components/schemas/SmsInitiateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmptyObject"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [],
"summary": "Initiate SMS login",
"tags": [
"Auth"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\n\nclient.auth().initiate_sms().await?;"
}
]
}
},
"/connection/subject/{subjectId}": {
"get": {
"description": "Fetches full detail for a connection subject.",
"operationId": "getConnectionDetail",
"parameters": [
{
"description": "Subject ID",
"in": "path",
"name": "subjectId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionDetailApi"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get connection detail",
"tags": [
"Connections"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet detail = client.connections().detail(\"subject_id\").await?;"
}
]
}
},
"/connection/v2": {
"get": {
"description": "Fetches current connections/matches.",
"operationId": "listConnections",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionsResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "List connections",
"tags": [
"Connections"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet matches = client.connections().list().await?;"
}
]
}
},
"/connection/v2/matchnote/{subjectId}": {
"get": {
"description": "Fetches match note for a subject.",
"operationId": "getMatchNote",
"parameters": [
{
"description": "Subject ID",
"in": "path",
"name": "subjectId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"note": "Liked your prompt"
}
}
},
"schema": {
"$ref": "#/components/schemas/MatchNoteResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get match note",
"tags": [
"Connections"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet note = client.connections().match_note(\"subject_id\").await?;"
}
]
}
},
"/content/v1": {
"delete": {
"description": "Deletes profile content by comma-separated content IDs.",
"operationId": "deleteContent",
"parameters": [
{
"description": "Comma-separated content IDs",
"in": "query",
"name": "ids",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmptyObject"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Delete content",
"tags": [
"Profiles"
]
}
},
"/content/v1/answer/evaluate": {
"post": {
"description": "Runs Hinge answer review before saving prompt content.",
"operationId": "evaluateAnswer",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnswerEvaluateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawJson"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Evaluate answer",
"tags": [
"Prompts"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet review = client.prompts().evaluate_answer(payload).await?;"
}
]
}
},
"/content/v1/answers": {
"put": {
"description": "Replaces answer content.",
"operationId": "updateAnswers",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnswersUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawJson"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Update answers",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet response = client.settings().update_answers(answers).await?;"
}
]
}
},
"/content/v1/prompt_poll": {
"post": {
"description": "Creates prompt poll content.",
"operationId": "createPromptPoll",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePromptPollRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreatePromptPollResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Create prompt poll",
"tags": [
"Prompts"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet created = client.prompts().create_prompt_poll(payload).await?;"
}
]
}
},
"/content/v1/settings": {
"get": {
"description": "Fetches content settings.",
"operationId": "getContentSettings",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSettings"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get content settings",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet settings = client.settings().content().await?;"
}
]
},
"patch": {
"description": "Updates content settings.",
"operationId": "updateContentSettings",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserSettings"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawJson"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Update content settings",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet response = client.settings().update_content(settings).await?;"
}
]
}
},
"/content/v1/video_prompt": {
"post": {
"description": "Creates video prompt content.",
"operationId": "createVideoPrompt",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVideoPromptRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateVideoPromptResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Create video prompt",
"tags": [
"Prompts"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet created = client.prompts().create_video_prompt(payload).await?;"
}
]
}
},
"/content/v2": {
"get": {
"description": "Fetches photos, prompts, and other profile content for the authenticated user.",
"operationId": "getSelfContent",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfContentResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get self content",
"tags": [
"Profiles"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet content = client.profiles().content().await?;"
}
]
}
},
"/content/v2/public": {
"get": {
"description": "Fetches public content records by comma-separated user IDs.",
"operationId": "getPublicProfileContent",
"parameters": [
{
"description": "Comma-separated user IDs",
"in": "query",
"name": "ids",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicContentResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get public profile content",
"tags": [
"Profiles"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet content = client\n .profiles()\n .public_content(vec![\"user_id\".to_string()])\n .await?;"
}
]
}
},
"/flag/textreview": {
"post": {
"description": "Runs Hinge text review and returns an HCM run ID used when sending notes/likes with comments.",
"operationId": "reviewMessageText",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"request": {
"value": {
"receiverId": "user_456",
"text": "hey"
}
}
},
"schema": {
"$ref": "#/components/schemas/TextReviewRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TextReviewResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Review message text",
"tags": [
"Chat"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet raw = client\n .raw()\n .hinge(\n reqwest::Method::POST,\n \"/flag/textreview\",\n Some(serde_json::json!({\n \"text\": \"hey\",\n \"receiverId\": \"user_id\"\n })),\n )\n .await?;"
}
]
}
},
"/group_channels": {
"post": {
"description": "Creates a distinct Sendbird group channel.",
"operationId": "createSendbirdDmChannel",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendbirdCreateChannelRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawJson"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"sendbirdSessionKey": []
}
],
"summary": "Create Sendbird DM channel",
"tags": [
"Sendbird REST"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet channel = client\n .chat()\n .get_or_create_dm_channel(\"self_user_id\", \"peer_user_id\")\n .await?;"
}
]
}
},
"/group_channels/{channelUrl}/messages": {
"get": {
"description": "Fetches message history around an optional timestamp anchor.",
"operationId": "getSendbirdMessages",
"parameters": [
{
"description": "URL-encoded channel URL",
"in": "path",
"name": "channelUrl",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Anchor timestamp",
"in": "query",
"name": "message_ts",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Number of previous messages",
"in": "query",
"name": "prev_limit",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendbirdMessagesResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"sendbirdSessionKey": []
}
],
"summary": "Get Sendbird messages",
"tags": [
"Sendbird REST"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet messages = client\n .chat()\n .full_messages(\"sendbird_group_channel\")\n .await?;"
}
]
}
},
"/identity/install": {
"post": {
"description": "Registers a generated install ID before SMS login.",
"operationId": "registerDeviceInstall",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"request": {
"value": {
"installId": "00000000-0000-0000-0000-000000000000"
}
}
},
"schema": {
"$ref": "#/components/schemas/InstallRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmptyObject"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [],
"summary": "Register device install",
"tags": [
"Auth"
]
}
},
"/like/subject/{subjectId}": {
"get": {
"description": "Fetches one like by subject ID.",
"operationId": "getLikeSubject",
"parameters": [
{
"description": "Subject ID",
"in": "path",
"name": "subjectId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LikeItemV2"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get like subject",
"tags": [
"Likes"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet like = client.likes().subject(\"subject_id\").await?;"
}
]
}
},
"/like/v2": {
"get": {
"description": "Fetches inbound likes.",
"operationId": "listLikes",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LikesV2Response"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "List likes",
"tags": [
"Likes"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet likes = client.likes().list().await?;"
}
]
}
},
"/likelimit": {
"get": {
"description": "Fetches remaining standard and super likes.",
"operationId": "getLikeLimit",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"likes": 8,
"superlikes": 1
}
}
},
"schema": {
"$ref": "#/components/schemas/LikeLimit"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get like limit",
"tags": [
"Likes"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet limit = client.likes().limit().await?;"
}
]
}
},
"/message/authenticate": {
"post": {
"description": "Exchanges Hinge auth for a Sendbird JWT.",
"operationId": "authenticateSendbird",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"request": {
"value": {
"refresh": false
}
}
},
"schema": {
"$ref": "#/components/schemas/SendbirdAuthenticateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"success": {
"value": {
"expires": "2026-04-26T00:00:00Z",
"token": "[redacted]"
}
}
},
"schema": {
"$ref": "#/components/schemas/SendbirdAuthToken"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Authenticate Sendbird",
"tags": [
"Chat"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet credentials = client.chat().credentials().await?;"
}
]
}
},
"/message/send": {
"post": {
"description": "Sends a message through Hinge after ensuring a Sendbird DM channel exists.",
"operationId": "sendHingeMessage",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"request": {
"value": {
"ays": false,
"matchMessage": true,
"messageData": {
"message": "hello"
},
"messageType": "text",
"origin": "connection",
"subjectId": "user_456"
}
}
},
"schema": {
"$ref": "#/components/schemas/SendMessagePayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawJson"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Send Hinge message",
"tags": [
"Chat"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet sent = client.chat().send_message(payload).await?;"
}
]
}
},
"/notification/v1/settings": {
"get": {
"description": "Fetches notification settings.",
"operationId": "getNotificationSettings",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationSettings"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get notification settings",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet settings = client.settings().notifications().await?;"
}
]
}
},
"/preference/v2/selected": {
"get": {
"description": "Fetches selected dating preferences.",
"operationId": "getSelfPreferences",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreferencesResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get self preferences",
"tags": [
"Profiles"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet preferences = client.settings().preferences().await?;"
}
]
},
"patch": {
"description": "Updates selected dating preferences.",
"operationId": "updateSelfPreferences",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreferencesUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawJson"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Update self preferences",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet response = client\n .settings()\n .update_preferences(preferences)\n .await?;"
}
]
}
},
"/prompts": {
"post": {
"description": "Fetches prompt catalog using a payload derived from profile and preferences.",
"operationId": "listPrompts",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PromptPayload"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PromptsResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "List prompts",
"tags": [
"Prompts"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet prompts = client.prompts().list().await?;"
}
]
}
},
"/rate/v2/initiate": {
"post": {
"description": "Creates a like, note, superlike, or skip rating.",
"operationId": "rateOrSkipUser",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateRate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LikeResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Rate or skip user",
"tags": [
"Ratings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet response = client.ratings().rate_user(rate_input).await?;"
}
]
}
},
"/rate/v2/respond": {
"post": {
"description": "Responds to an inbound like/match flow.",
"operationId": "respondToRate",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RateRespondRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RateRespondResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Respond to rate",
"tags": [
"Ratings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet response = client.ratings().respond(rate_response).await?;"
}
]
}
},
"/rec/v2": {
"post": {
"description": "Fetches recommendation feeds for the authenticated user.",
"operationId": "getRecommendations",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"examples": {
"request": {
"value": {
"activeToday": false,
"newHere": false,
"playerId": "user_123"
}
}
},
"schema": {
"$ref": "#/components/schemas/RecommendationsRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RecommendationsResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get recommendations",
"tags": [
"Recommendations"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet recs = client.recommendations().get().await?;"
}
]
}
},
"/sdk/chat/export": {
"post": {
"description": "SDK helper that fetches channel/profile context and writes a local markdown export. This is not a remote Hinge endpoint.",
"operationId": "exportChatHelper",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportChatInput"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportChatResult"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Export chat helper",
"tags": [
"Chat"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet result = client\n .chat()\n .export_chat(hinge_rs::models::ExportChatInput {\n channel_url: \"sendbird_group_channel\".to_string(),\n output_dir: \"exports/chat\".to_string(),\n include_media: true,\n initiation_summary_lines: None,\n })\n .await?;"
}
]
}
},
"/sdk/group_channels/{channelUrl}": {
"get": {
"description": "Fetches a Sendbird group channel using the SDK endpoint.",
"operationId": "getSendbirdChannel",
"parameters": [
{
"description": "URL-encoded channel URL",
"in": "path",
"name": "channelUrl",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendbirdGroupChannel"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"sendbirdSessionKey": []
}
],
"summary": "Get Sendbird channel",
"tags": [
"Sendbird REST"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet channel = client\n .chat()\n .channel(\"sendbird_group_channel\")\n .await?;"
}
]
}
},
"/sendbird/ws": {
"get": {
"description": "Pseudo-operation documenting the Sendbird WebSocket handshake and typed events. The Rust client connects to wss://ws-{appId}.sendbird.com/.",
"operationId": "connectSendbirdWebSocket",
"responses": {
"101": {
"description": "WebSocket upgrade accepted"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
}
},
"security": [
{
"sendbirdWsAuth": []
}
],
"summary": "Connect Sendbird WebSocket",
"tags": [
"Sendbird WebSocket"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet mut events = client.chat().subscribe_events().await?;\nlet event = events.recv().await?;\nprintln!(\"{event:?}\");"
}
],
"x-websocket-events": {
"client": [
"READ",
"PING",
"TPST",
"TPEN",
"ENTR",
"EXIT",
"MACK",
"CLOSE"
],
"server": [
"LOGI",
"READ",
"SYEV",
"PING",
"PONG",
"CLOSE"
]
}
}
},
"/standouts/v3": {
"get": {
"description": "Fetches standout recommendations.",
"operationId": "getStandouts",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StandoutsResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get standouts",
"tags": [
"Recommendations"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet standouts = client.connections().standouts().await?;"
}
]
}
},
"/store/v2/account": {
"get": {
"description": "Fetches account and subscription information.",
"operationId": "getAccountInfo",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountInfo"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get account info",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet account = client.settings().account_info().await?;"
}
]
}
},
"/user/export/status": {
"get": {
"description": "Fetches account data export status.",
"operationId": "getExportStatus",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportStatus"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get export status",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet status = client.settings().export_status().await?;"
}
]
}
},
"/user/repeat": {
"get": {
"description": "Requests repeated profiles from Hinge.",
"operationId": "repeatProfiles",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawJson"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Repeat profiles",
"tags": [
"Recommendations"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet repeated = client.recommendations().repeat_profiles().await?;"
}
]
}
},
"/user/v2/traits": {
"get": {
"description": "Fetches user traits.",
"operationId": "getUserTraits",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserTraitsResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get user traits",
"tags": [
"Settings"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet traits = client.settings().user_traits().await?;"
}
]
}
},
"/user/v3": {
"get": {
"description": "Fetches the authenticated user's profile.",
"operationId": "getSelfProfile",
"parameters": [],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfProfileResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get self profile",
"tags": [
"Profiles"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet profile = client.profiles().me().await?;"
}
]
},
"patch": {
"description": "Applies profile updates using Hinge's numeric enum wire format.",
"operationId": "updateSelfProfile",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfileUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RawJson"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Update self profile",
"tags": [
"Profiles"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet response = client.profiles().update(profile_update).await?;"
}
]
}
},
"/user/v3/public": {
"get": {
"description": "Fetches public profile records by comma-separated user IDs.",
"operationId": "getPublicProfiles",
"parameters": [
{
"description": "Comma-separated user IDs",
"in": "query",
"name": "ids",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicProfilesResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"bearerAuth": []
}
],
"summary": "Get public profiles",
"tags": [
"Profiles"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet profiles = client\n .profiles()\n .public(vec![\"user_id\".to_string()])\n .await?;"
}
]
}
},
"/users/{userId}/my_group_channels": {
"get": {
"description": "Lists Sendbird group channels for the authenticated user using the mobile SDK query shape.",
"operationId": "listMySendbirdChannels",
"parameters": [
{
"description": "Sendbird user ID",
"in": "path",
"name": "userId",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Sendbird user ID repeated by the SDK",
"in": "query",
"name": "user_id",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Maximum channels",
"in": "query",
"name": "limit",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Peer user ID for exact one-to-one channel lookup",
"in": "query",
"name": "members_exactly_in",
"required": false,
"schema": {
"type": "string"
}
},
{
"description": "Sendbird channel ordering",
"in": "query",
"name": "order",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendbirdChannelsResponse"
}
}
},
"description": "Success"
},
"400": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Bad request"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Unauthorized"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized"
},
"429": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Rate limited"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Rate limited"
},
"500": {
"content": {
"application/json": {
"examples": {
"error": {
"value": {
"error": "Server error"
}
}
},
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Server error"
}
},
"security": [
{
"sendbirdSessionKey": []
}
],
"summary": "List my Sendbird channels",
"tags": [
"Sendbird REST"
],
"x-codeSamples": [
{
"label": "hinge-rs",
"lang": "Rust",
"source": "let mut client = hinge_rs::Client::builder()\n .phone_number(\"+15555550123\")\n .build()?;\nclient.persistence().load_session(\"session.json\")?;\n\nlet channels = client.chat().channels(30).await?;"
}
]
}
}
},
"servers": [
{
"description": "Hinge production API",
"url": "https://prod-api.hingeaws.net"
},
{
"description": "Sendbird REST API",
"url": "https://api-{sendbirdAppId}.sendbird.com/v3",
"variables": {
"sendbirdAppId": {
"default": "3cdad91c-1e0d-4a0d-bbee-9671988bf9e9"
}
}
}
],
"tags": [
{
"description": "Device install, SMS OTP, email 2FA, and auth settings.",
"name": "Auth"
},
{
"description": "Recommendation feeds, standouts, and repeat profiles.",
"name": "Recommendations"
},
{
"description": "Self, public, and profile-content APIs.",
"name": "Profiles"
},
{
"description": "Inbound likes, like limits, and like subject lookup.",
"name": "Likes"
},
{
"description": "Like, note, superlike, skip, and response flows.",
"name": "Ratings"
},
{
"description": "Prompt catalog and prompt-content creation.",
"name": "Prompts"
},
{
"description": "Matches, connection detail, and match notes.",
"name": "Connections"
},
{
"description": "Preferences, notifications, user traits, account, and export status.",
"name": "Settings"
},
{
"description": "Hinge chat helpers and local export support.",
"name": "Chat"
},
{
"description": "Sendbird channel, message, and group-channel endpoints used by Hinge chat.",
"name": "Sendbird REST"
},
{
"description": "Documented Sendbird WebSocket handshake and typed frame events.",
"name": "Sendbird WebSocket"
}
],
"x-scalar-environments": {
"local-mock": {
"color": "#059669",
"description": "Local Wiremock / WebSocket test server",
"variables": {
"hingeBaseUrl": "http://127.0.0.1:8080",
"sendbirdApiUrl": "http://127.0.0.1:8081/v3"
}
},
"production": {
"color": "#2563eb",
"description": "Hinge production and Sendbird production",
"variables": {
"hingeBaseUrl": {
"default": "https://prod-api.hingeaws.net",
"description": "Hinge REST API base URL"
},
"sendbirdApiUrl": {
"default": "https://api-3cdad91c-1e0d-4a0d-bbee-9671988bf9e9.sendbird.com/v3",
"description": "Sendbird REST API base URL"
}
}
}
}
}