Account

This namespace is designed to facilitate crucial account-related activities and insights. It encompasses a range of functionalities essential for enhancing user interaction and management within the platform.

This namespace primarily focuses on integrating user and company-specific settings and preferences into Alfred's workflow. It includes capabilities for setting up and managing webhooks for real-time interaction, understanding and managing the user's affiliations with different companies, and overseeing the tags and classification criteria linked to these companies.

The essence of the Account namespace is to provide users with the tools and information necessary to tailor their experience on the platform. It enables a deeper understanding of how their account interacts with various components of Alfred, and how their document processing tasks align with company-specific requirements.

Get the current user's companies

GET https://tagshelf.host/api/account/companies

Get a list of companies the authenticated requesting user has access to.

Headers

Name	Type	Description
X-TagshelfAPI-Key	String	Application API Key
Authorization	String	Bearer <access_token> or amx <hmac_token>
User-Agent*	String	Identifier for application, operating system, vendor, and/or version of the requesting user agent.

200 OK

[
    {
        "id": "6741b36a-35ac-43c5-8d61-ad1393cfbe6f,
        "name": "ACME CO"
    }
]

Get company's tags

GET https://tagshelf.host/api/account/tags/:company-id

Get a list of tags for a given company.

This request will only be valid for companies the requesting user has access to.

Path Parameters

Name	Type	Description
company-id*	UUID	Company ID

Headers

Name	Type	Description
X-TagshelfAPI-Key	String	Application API Key
Authorization	String	Bearer <access_token> or amx <hmac_token>
User-Agent*	String	Identifier for application, operating system, vendor, and/or version of the requesting user agent

200 OK

[
    {
        "id": "c13e4c7f-bdeb-4820-858b-2b921e62291c",
        "name": "FACTURA",
        "description": null
    }
]

Set a webhook for a given account.

POST https://tagshelf.host/api/account/webhook

Sets a web hook for a given account. An HTTP end-point will get notified every time an event is triggered within the system.

A webhook (also called a web callback or HTTP push API) is a way for an app to provide other applications with real-time information. A webhook delivers data to other applications as it happens, meaning you get data immediately—unlike typical APIs where you would need to poll for data very frequently to get it in real time.

You can learn more about Web Hook configuration, setup or event types in our Event API page. Anatomy of the Request

Headers

Name	Type	Description
Content-Type	String	application/json
Authorization	String	Bearer <access_token> or amx <hmac_token>
X-TagshelfAPI-Key	String	Application API Key
User-Agent*	String	Identifier for application, operating system, vendor, and/or version of the requesting user agent

Request Body

Name	Type	Description
url*	String	Endpoint URL to which all events will be notified via POST request.

200 OK

200 － OK
{
  "id": "559167cb-4c76-4e28-bf15-34cbf614119c",
  "url": "https://my.webhook.co/path"
}