Skip to main content
GET
/
api
/
v0
/
users
Lists all users.
curl --request GET \
  --url https://north.sh/api/v0/users \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "01jh1234abcd5678efgh",
      "name": "John Doe",
      "email": "[email protected]",
      "theme": "dark",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "current_page": 1,
  "first_page_url": "http://localhost/api/v0/users?page=1",
  "from": 1,
  "last_page": 2,
  "last_page_url": "http://localhost/api/v0/users?page=2",
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "http://localhost/api/v0/users?page=2",
  "path": "http://localhost/api/v0/users",
  "per_page": 15,
  "prev_page_url": "<string>",
  "to": 15,
  "total": 25
}

Authorizations

​
Authorization
string
header
required

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

Response

default - application/json

List of users retrieved successfully

​
data
object[]

Array of users

​
current_page
integer
Example:

1

​
first_page_url
string
Example:

"http://localhost/api/v0/users?page=1"

​
from
integer
Example:

1

​
last_page
integer
Example:

2

​
last_page_url
string
Example:

"http://localhost/api/v0/users?page=2"

​
links
object[]
​
next_page_url
string | null
Example:

"http://localhost/api/v0/users?page=2"

​
path
string
Example:

"http://localhost/api/v0/users"

​
per_page
integer
Example:

15

​
prev_page_url
string | null
​
to
integer
Example:

15

​
total
integer
Example:

25