GET
/
v2
/
users
Authorization
Query
curl --request GET \
  --url https://api.senddotssandbox.com/api/v2/users \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "compliance": {
        "1099_collected": "boolean",
        "address_collected": "boolean",
        "date_of_birth_collected": "boolean",
        "flagged": "boolean",
        "id_verified": "boolean",
        "must_collect_1099": "boolean",
        "tax_id_collected": "boolean",
        "w8_ben_collected": "boolean"
      },
      "email": "string",
      "first_name": "string",
      "id": "string",
      "last_name": "string",
      "metadata": [
        "string",
        "object",
        "null"
      ],
      "phone_number": {
        "country_code": "string",
        "phone_number": "string"
      },
      "wallet": {
        "amount": "integer",
        "credit_balance": "integer",
        "withdrawable_amount": "integer"
      }
    }
  ],
  "has_more": "boolean"
}

Authorizations

Authorizationheaderrequired
string

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

starting_after
string

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa, your subsequent call can include starting_after=aaa in order to fetch the next page of the list.

limit
integer

A limit on the number of objects to be returned, between 1 and 100.

ending_before
string

A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with aaa, your subsequent call can include ending_before=aaa in order to fetch the previous page of the list.

Response

200 - application/json
data
object[]

Array of user objects.

has_more
boolean

true if there are more objects.

Retrieve a UserAdd Compliance Information