Fetch users
GET {{baseUrl}}/users?page=<integer>&per_page=<integer>&last_seen_at:before=<string>&last_seen_at:after=<string>&last_notified_at:before=<string>&last_notified_at:after=<string>&order_by=last_seen_at,ASC
Fetches users for the project identified by the auth keys. Supports filtering, ordering, and pagination.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page | string | The page number of the paginated response. Defaults to 1. | |
per_page | string | The number of items per page. Defaults to 20. | |
last_seen_at:before | string | Fetch users seen before the specified last_seen_at timestamp. Please send it in RFC3339 format | |
last_seen_at:after | string | Fetch users seen after the specified last_seen_at timestamp. Please send it in RFC3339 format | |
last_notified_at:before | string | Fetch users last notified before the specified last_notified_at timestamp. Please send it in RFC3339 format | |
last_notified_at:after | string | Fetch users last notified after the specified last_notified_at timestamp. Please send it in RFC3339 format | |
order_by | string | Use it to order the returned list of users. Defaults to created_at,DESC |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MAGICBELL-API-KEY | string | (Required) The (public) API key of your MagicBell project. | |
X-MAGICBELL-API-SECRET | string | (Required) The API secret of your MagicBell project. | |
Accept | string |
RESPONSES
status: OK
{"current_page":"\u003cinteger\u003e","per_page":"\u003cinteger\u003e","users":[{"id":"\u003cstring\u003e","external_id":"\u003cstring\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","custom_attributes":{"eiusmod_754":"Excepteur aute in cupidatat sint","in761":"ut ipsum cupidatat sit"},"phone_numbers":["\u003cstring\u003e","\u003cstring\u003e"]},{"id":"\u003cstring\u003e","external_id":"\u003cstring\u003e","email":"\u003cstring\u003e","first_name":"\u003cstring\u003e","last_name":"\u003cstring\u003e","custom_attributes":{"officia_b01":"eiusmod velit pariatur dolor"},"phone_numbers":["\u003cstring\u003e","\u003cstring\u003e"]}]}