---
title: "get all"
method: GET
path: "/users"
tags: ["Users"]
---

# get all

`GET /users`

Returns a list of users you've previously created. The users will be returned in descending order of when they were created, unless you specify otherwise.
#### For custom components:
`RaiselyComponents.api.all('users').get(params = {}, headers = {}) => Promise<{result}>`

 :fa-gears: See [Restie Response Data](https://github.com/raisely/restie#reading-and-handling-responses) for a more detailed overview of responses through the client wrapper

## Query parameters

- `private` boolean
- `q` string
- `limit` number
- `offset` number
- `sort` string
- `order` 'asc' | 'desc'
- `postcode` string
- `country` string
- `facebookId` string
- `email` string
- `fullName` string
- `phone_number` string
- `organisation` string

## Headers

- `Authorization` string

## Response `200`

The resulting collection of User records

- object
  - `data` MemberUser[]
    - `accessToken` string — `public` A secret token for this user, used to authenticate them against the API or in your campaign.
    - `address1` string — `public` Line 1 of an address
    - `address2` string — `public` Line 2 of an address
    - `adminSettings` object — `public` Object containing settings for admin users
      - `v4BetaOptin` boolean — `public` Whether admin has opted into v4
      - `starredCampaigns` string[] — `public` Array of favourite campaigns for user
    - `country` string — `public` The country of the user
    - `createdAt` string — `public` Date the record was created
    - `email` string — `public` The user's email address. Raisely uses this as a unique identifier and will deduplicate on email.
    - `facebookId` string — `public` The Facebook ID provided on authentication
    - `firstName` string — `public` The first name of the user
    - `fullName` string — `public` The full name of the user
    - `internal` object — `public` Internal values related to this record
    - `ipCity` string — `public` Deprecated
    - `ipCountry` string — `public` Deprecated
    - `ipLatitude` number — `public` Deprecated
    - `ipLongitude` number — `public` Deprecated
    - `ipNumber` string — `public` Deprecated
    - `isAdmin` boolean — `public` Will be true if this user has admin permissions
    - `isSamlLogin` boolean — `public` Will be true if this user logs in via organisation SAML login
    - `language` string — `public` The language the user last interacted in
    - `lastName` string — `public` The last name of the user
    - `organisationUuid` string — `public` Unique identifier for the record
    - `permission` string — `public` Deprecated. Use roles
    - `phoneNumber` string — `public` Phone number of the user
    - `photoUrl` string — `public` URL of the user's photo
    - `postcode` string — `public` Postal code of the user
    - `preferredName` string — `public` The name that the user prefers to be called
    - `private` object — `public` Private values for this record
    - `public` object — `public` Public values for this record
    - `state` string — `public` The state/province of the user
    - `status` 'ACTIVE' | 'DELETED' | 'PENDING' — `public` ACTIVE, DELETED, or PENDING
    - `suburb` string — `public` The suburb/city of the user
    - `swiftAidAuthExpiry` string — `public` Date of expiry of donor authorisation for SwiftAid
    - `swiftAidDonorId` string — `public` Id of donor on SwiftAid
    - `tags` NestedTag[] — `public`
      - `color` string — `public` The color used to display this tag within the admin interface
      - `createdAt` string — `public` Date the record was created
      - `internal` object — `public` Internal values related to this record
      - `isPrivate` boolean — `public` Indicates if this tag is publicly available
      - `label` string — `public` The text used to identity this tag within the admin interface
      - `organisationUuid` string — `public` Unique identifier for the record
      - `path` string — `public` The path of this record (for alternative lookup)
      - `recordType` string — `public` The type of record represented by this tag
      - `updatedAt` string — `public` Date the record was last updated
      - `uuid` string — `public` Unique identifier for the record
    - `unsubscribedAt` string — `public` ISO8601 timestamp of when the user was unsubscribed from non-essential emails or sms. A blank value indicates the user is still subscribed.
    - `updatedAt` string — `public` Date the record was last updated
    - `username` string — `public` The login email for this user
    - `uuid` string — `public` Unique identifier for the record
  - `pagination` Pagination
    - `total` integer — The total amount of records returned
    - `pages` integer — The amount of pages (by limit) returned
    - `prevUrl` union — Url that points to the previous set of records in the pagination if available
      - string
      - boolean
    - `nextUrl` union — Url that points to the next set of records in the pagination if available
      - string
      - boolean
    - `offset` integer — The total number of records to offset in the pagination
    - `limit` integer — The maximum amount of records to shown in each page

## Other responses

- `401` — Authorization credentials were missing or invalid
- `403` — The user is authenticated, but is not allowed to perform the requested operation
- `404` — One of the records needed to complete the request could not be found
- `410` — The requested record no longer exists, or that API has been deprecated
- `429` — You have made too many requests to the given endpoint, please try again later
- `500` — An unexpected error has occurred with Raisely. If the error persists you can contact support@raisely.com

---

[API](https://skmtc.net/raisely/apis/raisely-api.md) · [All operations](https://skmtc.net/raisely/apis/raisely-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/raisely/raisely-api/versions/d7f8dd294cb0/schema)