The patterns saved on this inbox

GET

/v1/inboxes/{id}/extractors

const url = 'https://api.facteur.eu/v1/inboxes/example/extractors';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.facteur.eu/v1/inboxes/example/extractors \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth
basicAuth

Parameters

Path Parameters

required

string

The inbox identifier — the same string that prefixes its receiving address.

Responses

200

The extractors, oldest first.

application/json

Array<object>

object

required

string

key

required

The property name this appears under in message.extract.

string

label

required

string

scope

required

string

Allowed values: text html subject

pattern

required

string

createdAt

string format: date-time

Example

[
  {
    "scope": "text"
  }
]

401

No usable credential. UNAUTHENTICATED when none was presented, KEY_UNKNOWN, KEY_REVOKED or KEY_EXPIRED when a key was — kept distinct on purpose, because “mint a new one” and “somebody took this away from you” are different facts to whoever is reading a red pipeline.

application/json

Every failure has this shape. Branch on error.code; error.message is written for a human and is in French today.

object

error

required

object

code

required

The stable, machine-readable reason.

string

message

A sentence for whoever is reading the failure. Not part of the contract.

string

Example

{
  "error": {
    "code": "SCOPE_INSUFFICIENT"
  }
}

403

SCOPE_INSUFFICIENT (the message names the scope this request wanted and the ones the key holds), KEY_CANNOT_REACH (no scope opens this route to a key at all), FORBIDDEN, or one of the stated refusals listed under x-api-key-refusals.

application/json

Every failure has this shape. Branch on error.code; error.message is written for a human and is in French today.

object

error

required

object

code

required

The stable, machine-readable reason.

string

message

A sentence for whoever is reading the failure. Not part of the contract.

string

Example

{
  "error": {
    "code": "SCOPE_INSUFFICIENT"
  }
}

404

INBOX_NOT_FOUND. An inbox in a workspace the key does not reach answers the same way as one that does not exist — telling the two apart would let anyone map a colleague’s workspaces one request at a time.

application/json

Every failure has this shape. Branch on error.code; error.message is written for a human and is in French today.

object

error

required

object

code

required

The stable, machine-readable reason.

string

message

A sentence for whoever is reading the failure. Not part of the contract.

string

Example

{
  "error": {
    "code": "SCOPE_INSUFFICIENT"
  }
}