Get Invite - Synap API (Beta)

Request

Path Params

object_id

string

required

The primary key for each resource.

Example:

FID001

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/vnd.api+json

Success

Body

data

object (Invite)

required

id

string

required

The primary key for each resource.

Example:

FID001

type

enum<string>

required

Identifies the Resource.

Allowed value:

Invite

Example:

Invite

attributes

object

optional

relationships

object

optional

Example

{
    "data": {
        "id": "FID001",
        "type": "Invite",
        "attributes": {
            "emailAddress": "string",
            "name": "string",
            "personalMessage": "string",
            "expiryDate": "string",
            "valid": true,
            "status": "pending",
            "lastSent": "string",
            "externalId": "string",
            "attr": {}
        },
        "relationships": {
            "owner": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "invitee": {
                "data": {
                    "id": "FID001",
                    "type": "User"
                }
            },
            "userGroup": {
                "data": {
                    "id": "FID001",
                    "type": "UserGroup"
                }
            },
            "subPortal": {
                "data": {
                    "id": "FID001",
                    "type": "SubPortal"
                }
            }
        }
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠422Parameter Error