Users

List Users

get/api/v1/users

Request

Base URL
https://merchant-api.accruesavings.com
Auth
none declared. Required headers: Client-ID, Authorization
TypeScript
https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/users/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

filter[phoneNumber]string

Filter the list of objects by the value of the phoneNumber field.

filter[email]string

Filter the list of objects by the value of the email field.

filter[referenceId]string

Filter the list of objects by the value of the referenceId field.

page[limit]number

Maximum number of objects that will be returned. Can not be greater than 50.

page[offset]number

Offset from the beginning of the list of objects. Can not be negative.

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000

Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

Example response

{
  "data": [
    {
      "attributes": {
        "attachedProfile": {
          "referenceId": "Any string identifier provided by you.",
          "stableReferenceId": "stable-abc-123",
          "effectiveReferenceId": "stable-abc-123",
          "email": "User email address kept in your system.",
          "phoneNumber": "User phone number kept in your system."
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "limit": 10
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.