User

Search for user using different options

GET https://app.bookboost.io/api/v2/partners/resources/app/{appUuid}/users/search

Returns list of users that match specified search criteria. At least one of the query parameters is required to perform a search.

Path Parameters

Name	Type	Description
appUuid*	String	The ID of an app within the organization

Query Parameters

Name	Type	Description
first_name	String	User first name
last_name	String	User last name
email	String	User e-mail address
external_id	String	If you have PMS/Importer integration, and the user comes from there, then you can search by their PMS ID

Headers

Name	Type	Description
Authorization*		Organization API key

200: OK Array of users, or empty array in case if nothing found

[
    {
        "id": "4bfb9fc7-e0cb-41f0-8366-810b6423907g",
        "first_name": "John",
        "last_name": "Doe"
    },
    {
        "id": "d3be063e-f119-47fe-8a6b-96d4cb97491d",
        "first_name": "Anna",
        "last_name": "Wisdomme"
    },
    ...
]

401: Unauthorized In case if organization key is incorrect

{
    // Response
}

Save user consent

POST https://app.bookboost.io/api/v2/partners/resources/app/{app_id}/users/{user_id}/consents

Create or update the existing consent for a particular user

Path Parameters

Name	Type	Description
app_id*	String	ID of an app within the organization
user_id*	String	User ID

Headers

Name	Type	Description
Authorization	String	Organization API key

Request Body

Name	Type	Description
consent_id*	String	Consent ID
granted*	Bool	Did user granted this consent

200: OK

{
    "user_id": "b12de3df-68f4-4859-9854-0a0aa1627537"
    "consent_id": "49405854-71d9-42e2-8b3f-5aafaf5c2836"
    "is_granted": true
}

401: Unauthorized In case if organization key is incorrect

{
    // Response
}