Users directory
42 routes. Paths are relative to https://api.intersink.com/v1.
- GET/userGet channel user profiles (tenant-scoped, paginated)
- GET/user/{id}Get a specific user profile by ID
- PATCH/user/{id}Update a specific user profile by ID
- POST/user/{id}/blockBlock a user profile
- GET/user/{id}/donationsGet a profile's public donations (paged, with total)
- POST/user/{id}/followFollow a user profile
- GET/user/{id}/followersGet list of followers for a profile
- GET/user/{id}/followingGet list of profiles this profile is following
- POST/user/{id}/unblockUnblock a user profile
- POST/user/{id}/unfollowUnfollow a user profile
- GET/user/categoriesGet list of User Categories
- GET/user/categoryGet list of User Categories
- GET/user/check-username/{username}Check if a username is available in the channel (x-ref, else the session's); same answer as GET /usernames/availability
- POST/user/kycCreate User KYC
- DELETE/user/profileDelete user profile and account (moves to trash)
- POST/user/profile/{id}Check if a username is available for a specific profile ID
- GET/user/profile/blockedGet all blocked profiles for the active profile
- POST/user/profile/createCreate a new user profile
- POST/user/profiledetailAdd or Update User Profile Detail (Upsert)
- POST/user/profileprivacyAdd or update user profile privacy settings
- GET/user/profilesGet profiles belonging to the currently logged-in user
- GET/usersGet channel user profiles (tenant-scoped, paginated)
- GET/users/{id}Get a specific user profile by ID
- PATCH/users/{id}Update a specific user profile by ID
- POST/users/{id}/blockBlock a user profile
- GET/users/{id}/donationsGet a profile's public donations (paged, with total)
- POST/users/{id}/followFollow a user profile
- GET/users/{id}/followersGet list of followers for a profile
- GET/users/{id}/followingGet list of profiles this profile is following
- POST/users/{id}/unblockUnblock a user profile
- POST/users/{id}/unfollowUnfollow a user profile
- GET/users/categoriesGet list of User Categories
- GET/users/categoryGet list of User Categories
- GET/users/check-username/{username}Check if a username is available in the channel (x-ref, else the session's); same answer as GET /usernames/availability
- POST/users/kycCreate User KYC
- DELETE/users/profileDelete user profile and account (moves to trash)
- POST/users/profile/{id}Check if a username is available for a specific profile ID
- GET/users/profile/blockedGet all blocked profiles for the active profile
- POST/users/profile/createCreate a new user profile
- POST/users/profiledetailAdd or Update User Profile Detail (Upsert)
- POST/users/profileprivacyAdd or update user profile privacy settings
- GET/users/profilesGet profiles belonging to the currently logged-in user
Get channel user profiles (tenant-scoped, paginated)
GET/user
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
Get a specific user profile by ID
GET/user/{id}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| active_profile_idrequired | string, query |
Response
200. The payload in data is of type object.
Update a specific user profile by ID
PATCH/user/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| firstname | string | Example: "Riya" |
| lastname | string | Example: "Goyal" |
| mobile | string | Example: "9999999999" |
| username | string | Example: "riya123" |
| avatar | string | Example: "https://example.com/photo.jpg" |
| language | string | |
| user_group | string | |
| user_category | string | |
| gender | string | |
| date_of_birth | string | |
| bio | string | |
| description | string | |
| link | string | |
| custom_link | string | |
| blood_group | string | |
| location | string | Home area "lat,lng" for people nearby (stored rounded to ~1 km) Example: "51.523,-0.078" |
| place | string | At most 120 characters. Example: "Shoreditch, London" |
Response
200. The payload in data is not described in the spec yet.
Block a user profile
POST/user/{id}/block
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Get a profile's public donations (paged, with total)
GET/user/{id}/donations
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Follow a user profile
POST/user/{id}/follow
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Get list of followers for a profile
GET/user/{id}/followers
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| ids_onlyrequired | string, query | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is of type object.
Get list of profiles this profile is following
GET/user/{id}/following
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| ids_onlyrequired | string, query | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is of type object.
Unblock a user profile
POST/user/{id}/unblock
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Unfollow a user profile
POST/user/{id}/unfollow
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Get list of User Categories
GET/user/categories
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. data is object[].
Get list of User Categories
GET/user/category
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. data is object[].
Check if a username is available in the channel (x-ref, else the session's); same answer as GET /usernames/availability
GET/user/check-username/{username}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| usernamerequired | string, path | |
| x-ref | string, header |
Response
200. The payload in data is of type object.
Create User KYC
POST/user/kyc
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| active_profile_id | string | Profile to file this KYC under (must be yours) |
| legalnamerequired | string | Example: "John Doe" |
| fathername | string | Example: "Richard Doe" |
| mothername | string | Example: "Jane Doe" |
| tax_id_number | string | Example: "ABCDE1234F" |
| id_number | string | Example: "ID-987654321" |
| nationality | string | Example: "Indian" |
| citizenship | string | Example: "India" |
Response
201. The payload in data is not described in the spec yet.
Delete user profile and account (moves to trash)
DELETE/user/profile
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| active_profile_idrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Check if a username is available for a specific profile ID
POST/user/profile/{id}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| usernamerequired | string | Example: "riya123" |
Response
201. The payload in data is of type object.
Get all blocked profiles for the active profile
GET/user/profile/blocked
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| active_profile_idrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Create a new user profile
POST/user/profile/create
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| firstname | string | Example: "Riya" |
| lastname | string | Example: "Goyal" |
| username | string | Example: "riya123" |
| avatar | string | Example: "https://example.com/photo.jpg" |
| language | string | |
| user_group | string | |
| user_category | string | |
| gender | string | |
| date_of_birthrequired | string | Example: "1995-04-21" |
| bio | string | |
| description | string | |
| link | string | |
| custom_link | string | |
| blood_group | string | |
| location | string | Home area "lat,lng" for people nearby (stored rounded to ~1 km) Example: "51.523,-0.078" |
| place | string | At most 120 characters. Example: "Shoreditch, London" |
Response
201. The payload in data is not described in the spec yet.
Add or Update User Profile Detail (Upsert)
POST/user/profiledetail
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| active_profile_id | string | Profile to update (must be yours) |
| zodiac | string | |
| clan | string | |
| mangal | boolean | |
| birth_place | object | |
| height | number | |
| weight | number | |
| body_type | string | |
| current_relationship | string | |
| relationship_intent | string | |
| current_children | boolean | |
| children_intent | boolean | |
| native_language | string | |
| languages | string[] | |
| orientation | string | |
| horoscope | string |
Response
201. The payload in data is not described in the spec yet.
Add or update user profile privacy settings
POST/user/profileprivacy
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| active_profile_id | string | Profile to update (must be yours) |
| martial_status | object | |
| orientation | object | |
| religion | object | |
| age | object | |
| height | object | |
| current_relationship_status | object | |
| location | object |
Response
200. The payload in data is not described in the spec yet.
Get profiles belonging to the currently logged-in user
GET/user/profiles
Needs a signed-in user (Bearer token or access_token cookie).
Response
200. The payload in data is not described in the spec yet.
Get channel user profiles (tenant-scoped, paginated)
GET/users
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. The payload in data is not described in the spec yet.
Get a specific user profile by ID
GET/users/{id}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| active_profile_idrequired | string, query |
Response
200. The payload in data is of type object.
Update a specific user profile by ID
PATCH/users/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| firstname | string | Example: "Riya" |
| lastname | string | Example: "Goyal" |
| mobile | string | Example: "9999999999" |
| username | string | Example: "riya123" |
| avatar | string | Example: "https://example.com/photo.jpg" |
| language | string | |
| user_group | string | |
| user_category | string | |
| gender | string | |
| date_of_birth | string | |
| bio | string | |
| description | string | |
| link | string | |
| custom_link | string | |
| blood_group | string | |
| location | string | Home area "lat,lng" for people nearby (stored rounded to ~1 km) Example: "51.523,-0.078" |
| place | string | At most 120 characters. Example: "Shoreditch, London" |
Response
200. The payload in data is not described in the spec yet.
Block a user profile
POST/users/{id}/block
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Get a profile's public donations (paged, with total)
GET/users/{id}/donations
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Follow a user profile
POST/users/{id}/follow
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
201. The payload in data is not described in the spec yet.
Get list of followers for a profile
GET/users/{id}/followers
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| ids_onlyrequired | string, query | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is of type object.
Get list of profiles this profile is following
GET/users/{id}/following
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| ids_onlyrequired | string, query | |
| pagerequired | string, query | |
| limitrequired | string, query |
Response
200. The payload in data is of type object.
Unblock a user profile
POST/users/{id}/unblock
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Unfollow a user profile
POST/users/{id}/unfollow
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Get list of User Categories
GET/users/categories
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. data is object[].
Get list of User Categories
GET/users/category
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| x-ref | string, header |
Response
200. data is object[].
Check if a username is available in the channel (x-ref, else the session's); same answer as GET /usernames/availability
GET/users/check-username/{username}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| usernamerequired | string, path | |
| x-ref | string, header |
Response
200. The payload in data is of type object.
Create User KYC
POST/users/kyc
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| active_profile_id | string | Profile to file this KYC under (must be yours) |
| legalnamerequired | string | Example: "John Doe" |
| fathername | string | Example: "Richard Doe" |
| mothername | string | Example: "Jane Doe" |
| tax_id_number | string | Example: "ABCDE1234F" |
| id_number | string | Example: "ID-987654321" |
| nationality | string | Example: "Indian" |
| citizenship | string | Example: "India" |
Response
201. The payload in data is not described in the spec yet.
Delete user profile and account (moves to trash)
DELETE/users/profile
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| active_profile_idrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Check if a username is available for a specific profile ID
POST/users/profile/{id}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| usernamerequired | string | Example: "riya123" |
Response
201. The payload in data is of type object.
Get all blocked profiles for the active profile
GET/users/profile/blocked
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| active_profile_idrequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Create a new user profile
POST/users/profile/create
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| firstname | string | Example: "Riya" |
| lastname | string | Example: "Goyal" |
| username | string | Example: "riya123" |
| avatar | string | Example: "https://example.com/photo.jpg" |
| language | string | |
| user_group | string | |
| user_category | string | |
| gender | string | |
| date_of_birthrequired | string | Example: "1995-04-21" |
| bio | string | |
| description | string | |
| link | string | |
| custom_link | string | |
| blood_group | string | |
| location | string | Home area "lat,lng" for people nearby (stored rounded to ~1 km) Example: "51.523,-0.078" |
| place | string | At most 120 characters. Example: "Shoreditch, London" |
Response
201. The payload in data is not described in the spec yet.
Add or Update User Profile Detail (Upsert)
POST/users/profiledetail
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| active_profile_id | string | Profile to update (must be yours) |
| zodiac | string | |
| clan | string | |
| mangal | boolean | |
| birth_place | object | |
| height | number | |
| weight | number | |
| body_type | string | |
| current_relationship | string | |
| relationship_intent | string | |
| current_children | boolean | |
| children_intent | boolean | |
| native_language | string | |
| languages | string[] | |
| orientation | string | |
| horoscope | string |
Response
201. The payload in data is not described in the spec yet.
Add or update user profile privacy settings
POST/users/profileprivacy
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| active_profile_id | string | Profile to update (must be yours) |
| martial_status | object | |
| orientation | object | |
| religion | object | |
| age | object | |
| height | object | |
| current_relationship_status | object | |
| location | object |
Response
200. The payload in data is not described in the spec yet.
Get profiles belonging to the currently logged-in user
GET/users/profiles
Needs a signed-in user (Bearer token or access_token cookie).
Response
200. The payload in data is not described in the spec yet.