GuidesAPI Reference
Log In
API Reference
  1. SCIM 2.0
  2. Users

List or search users.

get
https://bonus.ly/api/scim20/Users

Returns a paginated SCIM ListResponse of users in the
authenticated company. Supports the SCIM filter grammar (per
RFC 7644 §3.4.2.2) for the attributes listed under "Filterable
attributes" below.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

SCIM filter expression. Filterable attributes:

  • userName eq "..."
  • emails.value eq "..." / emails eq "..."
  • externalId eq "..."
  • name.givenName eq "..."
  • name.familyName eq "..."

active is intentionally NOT filterable — by design, the
list endpoint returns active and deactivated users together
so IdPs can detect drift on both sides.

integer
≥ 1
Defaults to 1

1-based starting index of the results to return (RFC 7644
§3.4.2.4). Default 1.

integer
0 to 100
Defaults to 100

Maximum number of resources per response. Defaults to 100,
which is also the hard maximum. Higher values are rejected
with a 400.

string

Comma-separated list of attribute names to include in the
response. When omitted, all readable attributes are returned.

Responses

Updated about 1 month ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/scim+json

Updated about 1 month ago