Add user search

[golf1052]

Request

Base URL: https://api.venmo.com/v1
Path: /users
Request type: GET
Query parameters:

key	value description
query	The search term, searches username as well as first and last name

Form Parameters

key	value description
access_token	Access token for user

Response

{
    "$schema": "http://json-schema.org/schema",
    "type": "object",
    "properties": {
        "pagination": {
            "type": "object",
            "description": "pagination info",
            "properties": {
                "previous": {
                    "type": "string",
                    "description": "previous page link, contains limit and offset parameters, can be null"
                },
                "next": {
                    "type": "string",
                    "description": "next page link, contains limit and offset parameters, can be null"
                },
                "data": {
                    "type": "array",
                    "description": "users data",
                    "items": {
                        "type": "object",
                        "properties": {
                            "username": {
                                "type": "string",
                                "description": "Venmo username"
                            },
                            "last_name": {
                                "type": "string",
                                "description": "Venmo user last name"
                            },
                            "friends_count": {
                                "type": "number",
                                "description": "???"
                            },
                            "is_group": {
                                "type": "boolean",
                                "description": "???"
                            },
                            "is_active": {
                                "type": "boolean",
                                "description": "active Venmo account"
                            },
                            "trust_request": {
                                "type": "boolean",
                                "description": "???"
                            },
                            "phone": {
                                "type": "string",
                                "description": "Venmo user phone number, null if not authorized user"
                            },
                            "profile_picture_url": {
                                "type": "string",
                                "description": "Venmo user profile picture url"
                            },
                            "is_blocked": {
                                "type": "boolean",
                                "description": "if the authorized user has this Venmo user blocked"
                            },
                            "id": {
                                "type": "string",
                                "description": "Venmo user id"
                            },
                            "identity": {
                                "type": "string",
                                "description": "???"
                            },
                            "date_joined": {
                                "type": "string",
                                "description": "the date when the user joined Venmo, in ISO 8601 format"
                            },
                            "about": {
                                "type": "string",
                                "description": "Venmo user's about info"
                            },
                            "display_name": {
                                "type": "string",
                                "description": "Venmo user's display name"
                            },
                            "identity_type": {
                                "type": "string",
                                "description": "The type of account this user is",
                                "enum": ["personal"]
                            },
                            "first_name": {
                                "type": "string",
                                "description": "Venmo user first name"
                            },
                            "friend_status": {
                                "type": "string",
                                "description": "friend status to the authorized user",
                                "enum": ["friend", "not_friend"]
                            },
                            "mutual_friends_count": {
                                "type": "number",
                                "description": "number of friends authorized user has that are friends with this user"
                            },
                            "email": {
                                "type": "string",
                                "description": "Venmo user email, null if not authorized"
                            }
                        }
                    }
                }
            }
        }
    }
}