---
title: "Auth API Reference"
description: "Endpoints for handling authentication in Linkbreakers. These endpoints allow you to sign in, request password reset, and reset passwords."
canonical: "https://linkbreakers.com/help/api/auth"
---

# Auth

Endpoints for handling authentication in Linkbreakers. These endpoints allow you to sign in, request password reset, and reset passwords.

## Auth

## [#](#auth-object)The Complete Google Forms OAuth Request object

code

string

Required

state

string

Required

Example object

```json
{
  "code": "string",
  "state": "string"
}
```

POST

`/v1/auth/email/verification/request`

Requires auth

## [#](#request-email-verification)Request email verification

Send a verification email to a member of the caller's workspace whose email is not verified yet. Opening the link verifies the address and the workspace, which lifts a WORKSPACE\_UNVERIFIED pause. Callable while the workspace is paused. The email must belong to a member of the workspace; one email per address per minute and 5 per day. Requires the \`members:write\` scope.

### [#](#request-email-verification-parameters)Parameters

#### header parameters

Idempotency-Key

string

header

Makes retrying this request safe. See components.parameters.IdempotencyKey.

### [#](#request-email-verification-request)Request body

email

string

Email address of the workspace member who should receive the verification email. Required. It must belong to a member of the caller's workspace whose email is not verified yet; the signed-in member's own address is returned by GET /v1/member. Opening the link in the email verifies that address and, with it, the workspace.

### [#](#request-email-verification-response)Response

200

Everything worked as expected.

No structured schema available for this section.

### [#](#request-email-verification-error)Error response

400-599

All endpoints may return an unexpected error payload when a request cannot be processed.

error

object

Required

Wrapped error response.

Example request (cURL)

```bash
curl -X POST "https://api.linkbreakers.com/v1/auth/email/verification/request" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: string" \
  -H "Content-Type: application/json" \
  --data '{"email":"you@example.com"}'
```

Sample payload (application/json)

```json
{
  "email": "you@example.com"
}
```

Typical response

```json
string
```

Base URL: `https://api.linkbreakers.com`

---

Source: https://linkbreakers.com/help/api/auth