Contacts

The Contacts API provides functionality for obtaining a list of Unet user contacts.


Basic information

Endpoints

RESOURCE_URI — URI is obtained from token exchange point.

Prefix Endpoint Description
RESOURCE_URI contacts/ Getting a list of user contacts

+Getting a list of user contacts

Endpoint

Scopes

  • user_contacts

Request

Response


Definitions

ContactsListRequest

Name Description

limit (o)
unsigned integer

Number of items expected in response.

cursor (o)
string

The value of the next_cursor / prev_cursor parameter from the responce.
Should be empty to get the first set (page) of elements.

fields (o)
object

Fields that it needs to be obtained.
Read more about the Fields model.

ContactsListResponse

Name Description

items[]
object

@ContactsItem

limit
unsigned integer

Number of returned items (items per page).

next_cursor
string

URL for the next portion of items (next page).
Empty if there is no items for the next portion.

prev_cursor
string

URL for the previous portion of items (previous page).
Empty if there is no items for the previous portion.

total_count
unsigned integer

Total number of items.

ContactsItemResponse

Name Description

uid
unsigned integer

User ID in Unet.

target_resource_uri
string

The URI to be used as TARGET_RESOURCE_URI in the API requests.

permissions ?
object

PermissionsResponse