GET
/
users
curl --request GET \
  --url https://api.useswift.dev/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "address": {
        "line1": "123 Main St",
        "line2": null,
        "city": "Anytown",
        "state": "CA",
        "zip": "12345"
      },
      "created_at": "2024-01-31T23:59:59Z",
      "date_of_birth": {
        "date": 27,
        "month": 7,
        "year": 1996
      },
      "email": "bob.smith@example.com",
      "phone": "1234567890",
      "first_name": "Bob",
      "id": "user_vjb43lkAdf934jb13Df93",
      "last_name": "Smith",
      "ssn": "123456789",
      "status": "active"
    }
  ],
  "next_cursor": "Y3Vyc29y"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
cursor
string

Return the page of entries after this one.

​
limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Required range: 1 <= x <= 100
​
status
string

Filter the list of Users by status.

Response

200
application/json
Users

A list of User objects.

​
data
object[]
required

The contents of the list.

Users represent end users capable of completing transfers via Swift's API.

​
next_cursor
string | null
required

A pointer to a place in the list.