List authentication challenge methods

GET

auth

challengeMethods

curl --request GET \
  --url https://api.guile.app/auth/challengeMethods \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "method": "sms",
      "label": "<string>"
    }
  ],
  "count": 1
}

Query Parameters

phoneNumber

string<phoneNumber>

The phone number of a user to trigger a one-time passcode validation for. A US-based phone number.

emailAddress

string<emailAddress>

The email address of a user to trigger a one-time passcode validation for. An email address.

Required string length: 6 - 100

Response

Ok. The operation succeeded.

A list response for resources. This response contains the full result set after any filters are applied.

items

object[]

required

Show child attributes

items.method

enum<string>

required

The type of the challenge method.

Available options:

sms,

email

items.label

string

required

The human readable description for the challenge method. Details are obscured using masking characters.

example: e******@guile.app

count

integer<int16>

required

Required range: x >= 0

Create an authentication challengeIssue an authentication challenge for user. Challenges are issued using previously known identification methods. New users will be issued a challenge using the email address or phone number provided in the request body. Challenges may only be issued on a fixed time interval.

⌘I

List authentication challenge methods

curl --request GET \
  --url https://api.guile.app/auth/challengeMethods \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "method": "sms",
      "label": "<string>"
    }
  ],
  "count": 1
}

Public APIs

API Concepts

Authentication

Appointments

Barbers

Businesses

Clients

Customers

Fees

Integrations

Invitations

Payouts

Photos

Refunds

Services

List authentication challenge methods

Query Parameters

Response