Dataset: Invites

Dataset name: ds_invites

Description

Invites

Fields in this dataset

Name	Field Name	Description	Field Type	Field Example
Created Timestamp	created_timestamp	Created Timestamp.	int	1638375529
Expire Timestamp	expire_timestamp	Unix Timestamp of when the invite expires.	int	1641991375
Invites ID	id	The primary identifier for this record.	serial	2
Identifier	identifier	Unique Identifier of what the invite is inviting the member to.	varchar	1
Invites Instance	instance	The instance this item relates to.	int	3
Known As	known_as	A label for the invite so that we know who we are inviting before we have a mydexid, and for good UX.	varchar	Julie
Name	name	Name of invited member.	varchar	Julie Dom
One Time Code	one_time_code	One time code that is generated with the invite.	varchar	1861227082
Recipient	recipient	Either phone number or email address.	varchar	dom.julie@email.com
Route	route	The route the invite used, either email, SMS or mydexId.	varchar	email
Invites Source	source	The source of the data - user or connection.	varchar
Status	status	The status of the invite.	varchar	received
Type	type	The type of the invite.	varchar	Invite
Updated Timestamp	updated_timestamp	Updated Timestamp.	int	1639153129

---

Making an API request for this Dataset

Example Request to the Sandbox Server

http://sbx-api.mydex.org/api/pds/transaction/UID.json
  ?key=KEY
  &api_key=API_KEY
  &con_id=CON_ID
  &source_type=connection
  &dataset=ds_invites
  &instance=N

Replace the following with your own details: UID KEY, API_KEY, CON_ID and instance N.

Replace sbx-api with api when making a connection to a real member on the production server (must be authenticated).

To return the data in XML, change UID.json to UID.xml.

Example Response

A response to this API request will be structured as follows.

{
  "2": {
    "id": "2",
    "ds_id": "2",
    "created_timestamp": "1638375529",
    "expire_timestamp": "1641991375",
    "identifier": "1",
    "known_as": "Julie",
    "name": "Julie Dom",
    "one_time_code": "1861227082",
    "recipient": "dom.julie@email.com",
    "route": "email",
    "status": "received",
    "type": "Invite",
    "updated_timestamp": "1639153129"
  }
}