Absorb Integration API (v1)

Download OpenAPI specification:Download

Messages

Get message.

Authorizations:

api_key

path Parameters

id

required

string <guid>

The ID of the message.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

id required	string <guid> The unique message identifier.
dateSent required	string <date-time> The message's date sent.
subject	string The message subject.
body	string The message body.
fromId	string <guid> The ID of the user the message was from.
toUserIds	Array of strings <guid> [ items <guid > ] The list of user IDs the message was sent to.
to	string The emails of the users the message was sent to.
from	string The name of the user the message was from.
conversationId required	string <guid> The message's conversation ID.
enrollmentId	string <guid> The message's enrollment ID
	Array of objects (Link)
	Array of objects (IEmbeddedResource)

Response samples

200
404

Content type

application/json

{"id": "string",
"dateSent": "2019-08-24T14:15:22Z",
"subject": "string",
"body": "string",
"fromId": "string",
"toUserIds": ["string"
],
"to": "string",
"from": "string",
"conversationId": "string",
"enrollmentId": "string",
"_links": [{"Rel": {"Name": "string"
},
"Items": [{"Href": "string",
"Name": "string",
"Templated": true,
"Type": "string",
"Deprecation": "string",
"Profile": "string",
"Title": "string",
"Hreflang": "string"
}
]
}
],
"_embedded": [{"Name": "string",
"Resources": [{"Links": [{"Rel": {"Name": "string"
},
"Items": [{"Href": "string",
"Name": "string",
"Templated": true,
"Type": "string",
"Deprecation": "string",
"Profile": "string",
"Title": "string",
"Hreflang": "string"
}
]
}
],
"EmbeddedResources": [{ }
]
}
]
}
]
}

List user messages.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The ID of the user.

query Parameters

_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> `Filterable` The unique message identifier.
dateSent	string <date-time> `Sortable` `Filterable` The message's date sent.
subject	string `Sortable` `Filterable` The message subject.
body	string The message body.
fromId	string <guid> `Sortable` `Filterable` The ID of the user the message was from.
toUserIds	Array of strings <guid> [ items <guid > ] `Sortable` `Filterable` The list of user IDs the message was sent to.
to	string `Sortable` `Filterable` The emails of the users the message was sent to.
from	string `Sortable` `Filterable` The name of the user the message was from.
conversationId	string <guid> `Sortable` `Filterable` The message's conversation ID.
enrollmentId	string <guid> `Sortable` `Filterable` The message's enrollment ID

Response samples

200
404
422

Content type

application/json

[{"id": "string",
"dateSent": "2019-08-24T14:15:22Z",
"subject": "string",
"body": "string",
"fromId": "string",
"toUserIds": ["string"
],
"to": "string",
"from": "string",
"conversationId": "string",
"enrollmentId": "string"
}
]

List user sent messages.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The ID of the user.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id required	string <guid> The unique message identifier.
dateSent required	string <date-time> The message's date sent.
subject	string The message subject.
body	string The message body.
fromId	string <guid> The ID of the user the message was from.
toUserIds	Array of strings <guid> [ items <guid > ] The list of user IDs the message was sent to.
to	string The emails of the users the message was sent to.
from	string The name of the user the message was from.
conversationId required	string <guid> The message's conversation ID.
enrollmentId	string <guid> The message's enrollment ID
	Array of objects (Link)
	Array of objects (IEmbeddedResource)

Response samples

200
404

Content type

application/json

[{"id": "string",
"dateSent": "2019-08-24T14:15:22Z",
"subject": "string",
"body": "string",
"fromId": "string",
"toUserIds": ["string"
],
"to": "string",
"from": "string",
"conversationId": "string",
"enrollmentId": "string",
"_links": [{"Rel": {"Name": "string"
},
"Items": [{"Href": "string",
"Name": "string",
"Templated": true,
"Type": "string",
"Deprecation": "string",
"Profile": "string",
"Title": "string",
"Hreflang": "string"
}
]
}
],
"_embedded": [{"Name": "string",
"Resources": [{"Links": [{"Rel": {"Name": "string"
},
"Items": [{"Href": null,
"Name": null,
"Templated": null,
"Type": null,
"Deprecation": null,
"Profile": null,
"Title": null,
"Hreflang": null
}
]
}
],
"EmbeddedResources": [{ }
]
}
]
}
]
}
]

List user received messages.

Authorizations:

api_key

path Parameters

userId

required

string <guid>

The ID of the user.

query Parameters

_filter	string One or more filter operations to be performed on the collection. The referenced fields must allow filtering. See the respective report's schema for which fields can be filtered. Supports most of the OData filter syntax. Supported operations: * eq, * ne, * gt, * ge, * lt, * le, * and, * or, * not, * () Supported functions: * substringof('value',fieldName), * endswith(fieldName,'value'), * startswith(fieldName,'value'), * tolower(fieldName), * toupper(fieldName) Examples: _filter=`firstname eq 'Jeffrey'` _filter=`id eq guid'a14c149a-2ce0-41d4-b532-02189ad3cb22'` _filter=`startsWith(lastname,'leb') or dateAdded ge datetime'1998-03-06T20:38:07Z'`
_sort	string Optional list of comma-separated fields to sort the collection by. The referenced fields must allow sorting. See the respective report's schema for which fields can be sorted. If not specified, all report fields are returned. To sort in a descending manner, prefix the field name with `-`. For example, `_sort=name,-date`, sorts the collection of items by `name` (ascending) and then by `date` (descending).
_limit	string The maximum number of items to return in the current page of the collection.
_offset	string The number of pages to offset into the collection.

header Parameters

x-api-key	string
x-api-version	string 1

Responses

Response Schema: application/json

Array

id	string <guid> `Filterable` The unique message identifier.
dateSent	string <date-time> `Sortable` `Filterable` The message's date sent.
subject	string `Sortable` `Filterable` The message subject.
body	string The message body.
fromId	string <guid> `Sortable` `Filterable` The ID of the user the message was from.
toUserIds	Array of strings <guid> [ items <guid > ] `Sortable` `Filterable` The list of user IDs the message was sent to.
to	string `Sortable` `Filterable` The emails of the users the message was sent to.
from	string `Sortable` `Filterable` The name of the user the message was from.
conversationId	string <guid> `Sortable` `Filterable` The message's conversation ID.
enrollmentId	string <guid> `Sortable` `Filterable` The message's enrollment ID

Response samples

200
404
422

Content type

application/json

[{"id": "string",
"dateSent": "2019-08-24T14:15:22Z",
"subject": "string",
"body": "string",
"fromId": "string",
"toUserIds": ["string"
],
"to": "string",
"from": "string",
"conversationId": "string",
"enrollmentId": "string"
}
]