UNunipile
Users

List all relations

Changed on

Returns a list of all the relations of an account. Ensure careful implementation of this action and consult provider limits and restrictions: https://developer.unipile.com/docs/provider-limits-and-restrictions

get/api/v1/users/relations

Request

Query parameters

cursorstring

A cursor for pagination purposes. To get the next page of entries, you need to make a new request and fulfill this field with the cursor received in the preceding request. This process should be repeated until all entries have been retrieved.

filterstring

Filter out results by user name.

limitinteger

A limit for the number of items returned in the response. The value can be set between 1 and 1000.

Example:100
account_idstring required

The account to get the relations from. (if user_id is not provided)

Response

OK. Request succeeded.

object'UserRelationsList' required

Changes

  • e74f29ca2aaaRevision changes
    • warning

      added the new errors/password_reset_required enum value to the response property for the response status

    • info

      added the optional property to the response with the status