API Reference

Invite User to Existing Org

Why would I use this?

This endpoint allows your integration to programmtically invite a user to your Hover organization.

Response Code Snippet

See an example 201 response here, a JSON blob containing the user's profile details, then follow below to learn more about the request, and what makes up the responses.

{
    "user": {
        "id": 1831048,
        "aasm_state": "invited",
        "accesses": [
            {
                "org_id": 492855,
                "user_id": 1831048,
                "free_job_quota": 0,
                "acl_template": "admin",
                "acl_options": null,
                "cc_admin_on_emails": false
            }
        ],
        "acl_options": {
            "orgs": [
                {
                    "template": "admin",
                    "jobs": [
                        "view_all",
                        "manage_all",
                        "assign",
                        "accesses"
                    ],
                    "billing_auths": [
                        "billing"
                    ],
                    "users": [
                        "read",
                        "add",
                        "remove",
                        "update",
                        "manage_permissions"
                    ],
                    "orgs": [
                        "read",
                        "manage",
                        "billing"
                    ],
                    "org_settings": [
                        "supports_machete"
                    ],
                    "machete_features": [
                        "measurements",
                        "share",
                        "design"
                    ],
                    "ordering": [],
                    "measurements": [
                        "propdf",
                        "pro_premium_pdf"
                    ],
                    "emails": [
                        "new_org_job_access"
                    ],
                    "id": "492855",
                    "kind": "dealer"
                },
                {
                    "template": "admin",
                    "jobs": [
                        "view_all",
                        "manage_all",
                        "assign",
                        "accesses"
                    ],
                    "billing_auths": [
                        "billing"
                    ],
                    "users": [
                        "read",
                        "add",
                        "remove",
                        "update",
                        "manage_permissions"
                    ],
                    "orgs": [
                        "read",
                        "manage",
                        "billing"
                    ],
                    "org_settings": [
                        "supports_machete"
                    ],
                    "machete_features": [
                        "measurements",
                        "share",
                        "design"
                    ],
                    "ordering": [],
                    "measurements": [
                        "propdf",
                        "pro_premium_pdf"
                    ],
                    "emails": [
                        "new_org_job_access"
                    ],
                    "id": "503269",
                    "kind": "dealer"
                },
                {
                    "template": "admin",
                    "jobs": [
                        "view_all",
                        "manage_all",
                        "assign",
                        "accesses"
                    ],
                    "billing_auths": [
                        "billing"
                    ],
                    "users": [
                        "read",
                        "add",
                        "remove",
                        "update",
                        "manage_permissions"
                    ],
                    "orgs": [
                        "read",
                        "manage",
                        "billing"
                    ],
                    "org_settings": [
                        "supports_machete"
                    ],
                    "machete_features": [
                        "measurements",
                        "share",
                        "design"
                    ],
                    "ordering": [],
                    "measurements": [
                        "propdf",
                        "pro_premium_pdf"
                    ],
                    "emails": [
                        "new_org_job_access"
                    ],
                    "id": "506947",
                    "kind": "dealer"
                },
                {
                    "template": "admin",
                    "jobs": [
                        "view_all",
                        "manage_all",
                        "assign",
                        "accesses"
                    ],
                    "billing_auths": [
                        "billing"
                    ],
                    "users": [
                        "read",
                        "add",
                        "remove",
                        "update",
                        "manage_permissions"
                    ],
                    "orgs": [
                        "read",
                        "manage",
                        "billing"
                    ],
                    "org_settings": [
                        "supports_machete"
                    ],
                    "machete_features": [
                        "measurements",
                        "share",
                        "design"
                    ],
                    "ordering": [],
                    "measurements": [
                        "propdf",
                        "pro_premium_pdf"
                    ],
                    "emails": [
                        "new_org_job_access"
                    ],
                    "id": "585264",
                    "kind": "company"
                },
                {
                    "template": "admin",
                    "jobs": [
                        "view_all",
                        "manage_all",
                        "assign",
                        "accesses"
                    ],
                    "billing_auths": [
                        "billing"
                    ],
                    "users": [
                        "read",
                        "add",
                        "remove",
                        "update",
                        "manage_permissions"
                    ],
                    "orgs": [
                        "read",
                        "manage",
                        "billing"
                    ],
                    "org_settings": [
                        "supports_machete"
                    ],
                    "machete_features": [
                        "measurements",
                        "share",
                        "design"
                    ],
                    "ordering": [],
                    "measurements": [
                        "propdf",
                        "pro_premium_pdf"
                    ],
                    "emails": [
                        "new_org_job_access"
                    ],
                    "id": "600530",
                    "kind": "company"
                }
            ]
        },
        "active_commerce_product": "out_of_the_box_configuration",
        "created_at": "2024-04-24T21:56:19.876Z",
        "downloaded_app": false,
        "email": "[email protected]",
        "first_name": "Jeff",
        "intercom_sha": "a74494596ebdf905643202004aae6f6a123e8b229c02f2c9c31cc69e05c7ddee",
        "is_homeowner": false,
        "last_name": "Hull",
        "last_sign_in_at": null,
        "locale": "hover",
        "mobile_phone": "+17757777778",
        "office_phone": null,
        "preferred_identifier": null,
        "require_job_approval": false,
        "search_rank": null,
        "test_data": true,
        "time_zone": "Pacific Time (US & Canada)",
        "upload_secret": "6b693939-b443-42df-8cdb-9270a3be55a5",
        "vip": false,
        "orgs": [],
        "capture_requests": [],
        "requested_captures": []
    }
}

Language
Credentials
Bearer
URL
Click Try It! to start a request and see the response here!