AlphaAlpha Docs
API Reference

Inbound Emails

Inbound Emails API

Download Csv_ Inbound Email

GET
/communications/inbox/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/inbox/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of entities by their IDs

DELETE
/communications/inbox/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/communications/inbox/delete-list?ids=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Inbound Email

GET
/communications/inbox/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/inbox/dynamic-search"
{
  "content": [
    {
      "bodyHtml": "string",
      "bodyText": "string",
      "cc": [
        "string"
      ],
      "conversationId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "fromEmail": "string",
      "fromName": "string",
      "graphMessageId": "string",
      "id": "string",
      "inReplyTo": "string",
      "internetMessageId": "string",
      "parentCommunicationId": "string",
      "receivedAt": "2019-08-24T14:15:22Z",
      "recipients": [
        "string"
      ],
      "relatedEntityId": "string",
      "relatedEntityType": "string",
      "status": "NEW",
      "subject": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Inbound Email

POST
/communications/inbox/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/inbox/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "bodyHtml": "string",
      "bodyText": "string",
      "cc": [
        "string"
      ],
      "conversationId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "fromEmail": "string",
      "fromName": "string",
      "graphMessageId": "string",
      "id": "string",
      "inReplyTo": "string",
      "internetMessageId": "string",
      "parentCommunicationId": "string",
      "receivedAt": "2019-08-24T14:15:22Z",
      "recipients": [
        "string"
      ],
      "relatedEntityId": "string",
      "relatedEntityType": "string",
      "status": "NEW",
      "subject": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/communications/inbox/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/inbox/find"
[
  {
    "bodyHtml": "string",
    "bodyText": "string",
    "cc": [
      "string"
    ],
    "conversationId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "fromEmail": "string",
    "fromName": "string",
    "graphMessageId": "string",
    "id": "string",
    "inReplyTo": "string",
    "internetMessageId": "string",
    "parentCommunicationId": "string",
    "receivedAt": "2019-08-24T14:15:22Z",
    "recipients": [
      "string"
    ],
    "relatedEntityId": "string",
    "relatedEntityType": "string",
    "status": "NEW",
    "subject": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/communications/inbox/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/inbox/find-all"
[
  {
    "bodyHtml": "string",
    "bodyText": "string",
    "cc": [
      "string"
    ],
    "conversationId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "fromEmail": "string",
    "fromName": "string",
    "graphMessageId": "string",
    "id": "string",
    "inReplyTo": "string",
    "internetMessageId": "string",
    "parentCommunicationId": "string",
    "receivedAt": "2019-08-24T14:15:22Z",
    "recipients": [
      "string"
    ],
    "relatedEntityId": "string",
    "relatedEntityType": "string",
    "status": "NEW",
    "subject": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/communications/inbox/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/inbox/find-list"
[
  {
    "bodyHtml": "string",
    "bodyText": "string",
    "cc": [
      "string"
    ],
    "conversationId": "string",
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "fromEmail": "string",
    "fromName": "string",
    "graphMessageId": "string",
    "id": "string",
    "inReplyTo": "string",
    "internetMessageId": "string",
    "parentCommunicationId": "string",
    "receivedAt": "2019-08-24T14:15:22Z",
    "recipients": [
      "string"
    ],
    "relatedEntityId": "string",
    "relatedEntityType": "string",
    "status": "NEW",
    "subject": "string",
    "tenantId": "string",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/communications/inbox/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/inbox/find/string"
{
  "bodyHtml": "string",
  "bodyText": "string",
  "cc": [
    "string"
  ],
  "conversationId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "fromEmail": "string",
  "fromName": "string",
  "graphMessageId": "string",
  "id": "string",
  "inReplyTo": "string",
  "internetMessageId": "string",
  "parentCommunicationId": "string",
  "receivedAt": "2019-08-24T14:15:22Z",
  "recipients": [
    "string"
  ],
  "relatedEntityId": "string",
  "relatedEntityType": "string",
  "status": "NEW",
  "subject": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/communications/inbox/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/inbox/page"
{
  "content": [
    {
      "bodyHtml": "string",
      "bodyText": "string",
      "cc": [
        "string"
      ],
      "conversationId": "string",
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "fromEmail": "string",
      "fromName": "string",
      "graphMessageId": "string",
      "id": "string",
      "inReplyTo": "string",
      "internetMessageId": "string",
      "parentCommunicationId": "string",
      "receivedAt": "2019-08-24T14:15:22Z",
      "recipients": [
        "string"
      ],
      "relatedEntityId": "string",
      "relatedEntityType": "string",
      "status": "NEW",
      "subject": "string",
      "tenantId": "string",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get unread inbox count

GET
/communications/inbox/unread-count

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/inbox/unread-count"
{
  "property1": 0,
  "property2": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/communications/inbox/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/communications/inbox/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Archive inbound email

POST
/communications/inbox/{id}/archive

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/inbox/string/archive"
{
  "bodyHtml": "string",
  "bodyText": "string",
  "cc": [
    "string"
  ],
  "conversationId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "fromEmail": "string",
  "fromName": "string",
  "graphMessageId": "string",
  "id": "string",
  "inReplyTo": "string",
  "internetMessageId": "string",
  "parentCommunicationId": "string",
  "receivedAt": "2019-08-24T14:15:22Z",
  "recipients": [
    "string"
  ],
  "relatedEntityId": "string",
  "relatedEntityType": "string",
  "status": "NEW",
  "subject": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/communications/inbox/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/inbox/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
POST
/communications/inbox/{id}/link

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/inbox/string/link" \  -H "Content-Type: application/json" \  -d '{    "relatedEntityId": "string",    "relatedEntityType": "string"  }'
{
  "bodyHtml": "string",
  "bodyText": "string",
  "cc": [
    "string"
  ],
  "conversationId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "fromEmail": "string",
  "fromName": "string",
  "graphMessageId": "string",
  "id": "string",
  "inReplyTo": "string",
  "internetMessageId": "string",
  "parentCommunicationId": "string",
  "receivedAt": "2019-08-24T14:15:22Z",
  "recipients": [
    "string"
  ],
  "relatedEntityId": "string",
  "relatedEntityType": "string",
  "status": "NEW",
  "subject": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Mark inbound email as read

POST
/communications/inbox/{id}/mark-read

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/inbox/string/mark-read"
{
  "bodyHtml": "string",
  "bodyText": "string",
  "cc": [
    "string"
  ],
  "conversationId": "string",
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "fromEmail": "string",
  "fromName": "string",
  "graphMessageId": "string",
  "id": "string",
  "inReplyTo": "string",
  "internetMessageId": "string",
  "parentCommunicationId": "string",
  "receivedAt": "2019-08-24T14:15:22Z",
  "recipients": [
    "string"
  ],
  "relatedEntityId": "string",
  "relatedEntityType": "string",
  "status": "NEW",
  "subject": "string",
  "tenantId": "string",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

H R Time Entry

Previous Page

Incoming Stock Transfers

Next Page