Sign in

Sign up

Integration

Integration

Integration endpoints

Get All

Description

Get all integrations.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

Responses

Description:

List of integrations

Type:

Array of Integration objects

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

get

/institution/:institutionId/integration/

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/ \
    -X GET \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Get by id

Description

Get an integration by id.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

integrationId

string

Required

Description:

The id of the integration

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Type:

Integration object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

get

/institution/:institutionId/integration/:integrationId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/:integrationId \
    -X GET \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Create

Description

Create a new integration.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

Responses

Type:

Integration object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

post

/institution/:institutionId/integration/

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/ \
    -X POST \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Update

Description

Update an integration.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

integrationId

string

Required

Description:

The id of the integration

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Type:

Integration object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

put

/institution/:institutionId/integration/:integrationId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/:integrationId \
    -X PUT \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Update Status

Description

Update the status of an integration.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

integrationId

string

Required

Description:

The id of the integration

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Type:

Integration object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

put

/institution/:institutionId/integration/:integrationId/status

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/:integrationId/status \
    -X PUT \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Delete

Description

Delete an integration.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

integrationId

string

Required

Description:

The id of the integration

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Type:

Integration object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

delete

/institution/:institutionId/integration/:integrationId

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/:integrationId \
    -X DELETE \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Archive

Description

Archive an integration.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

integrationId

string

Required

Description:

The id of the integration

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Type:

Integration object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

post

/institution/:institutionId/integration/:integrationId/archive

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/:integrationId/archive \
    -X POST \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Unarchive

Description

Unarchive an integration.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

integrationId

string

Required

Description:

The id of the integration

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Type:

Integration object

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

post

/institution/:institutionId/integration/:integrationId/unarchive

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/:integrationId/unarchive \
    -X POST \
    -H 'Authorization: Bearer <token>' \

Response

1
2
3
4
5
6
7
8
9
10
11
12
13
{
    _id: "0f9c0b0b4f0c6b0017f0e3b1",
    institution: "0f9c0b0b4f0c6b0017f0e3b1",
    name: "Integration Name",
    type: "Email",
    provider: "Gmail",
    config: {},
    status: "Active",
    statusHistory: [],
    archivedOn: "2025-01-18T06:04:42.114Z",
    createdAt: "2025-01-18T06:04:42.114Z",
    updatedAt: "2025-01-18T06:04:42.114Z"
}

Test

Description

Test an integration.

Parameters

headers

Authorization

string

Required

Description:

Bearer token - JWT

Example:

"Bearer <token>"

params

integrationId

string

Required

Description:

The id of the integration

Example:

"0f9c0b0b4f0c6b0017f0e3b1"

Responses

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Invalid Role",
    message: "You do not have the required role to access this resource",
    status: 401
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Entity not found",
    message: "Entity not found",
    status: 404
}

Type:

Error object

Example:

1
2
3
4
5
{
    name: "Internal Server Error",
    message: "Internal Server Error",
    status: 500
}

post

/institution/:institutionId/integration/:integrationId/test

Request

1
2
3
4
curl https://app.fassport.co/api/v1/institution/:institutionId/integration/:integrationId/test \
    -X POST \
    -H 'Authorization: Bearer <token>' \

Response

1

Campaign

support@fassport.co

Copyright © Fassport 2025 • Terms • Privacy •