HomeGuidesAPI ReferenceAPI Changelog
Log In
API Reference

Lookup a user

GET https://app.referralsaasquatch.com/api/v1/{tenant_alias}/open/account/{accountId}/user/{userId}

This method looks up a user based on their id and returns their personal information including sharelinks. This endpoint requires authentication via a write token or API credentials.

Path Parameters

accountId string required

The unique identifier of the account being created.

userId string required

The unique identifier of the user.

tenant_alias string required

Tenant being referenced. E.g., "aboih12h16t".

Query Parameters

fields string

The fields to be included in the response. Cannot coexist with extraFields. E.g., "firstName, lastName, dateBlocked". Defaults to null.

extraFields string

The fields to be included in the response in addition to all the default fields. To select from default fields, use fields. Cannot coexist with extraFields. E.g., "firstName, lastName, dateBlocked". Defaults to null.

Responses

Refer to this guide for an explanation of possible Error Responses.