API docs by Redocly

TuitionFit (v0)

Download OpenAPI specification:Download

Connections

Get all connections

query Parameters
state
string

An optional ConnectionState used to filter the connections (Pending, Accepted, Rejected, Canceled, Revoked)

studentId
string

An optional student ID by which to search

studentEmail
string

An optional student Email by which to search

Responses

Response samples

Content type
[
  • {
    }
]

Create a new connection

Request Body schema:

The connection request

email
required
string [ 5 .. 100 ] characters

The email of the student (5-100 characters)

scope
required
string

The scope of the connection (ReadOnly, ReadWrite)

Responses

Request samples

Content type
{
  • "email": "string",
  • "scope": "string"
}

Response samples

Content type
{ }

Get a single connection

path Parameters
id
required
string

The unique identifier of the connection

Responses

Response samples

Content type
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "student": {
    },
  • "state": "Pending",
  • "scope": "ReadOnly"
}

Cancel or revoke an existing connection

path Parameters
id
required
string

The unique identifier of the connection

Responses

Response samples

Content type
{ }

Health

Check the health of the Partner API

Responses

Response samples

Content type
"string"

Letters

Get all letters, regardless of student.

query Parameters
email
string

Responses

Response samples

Content type
[
  • {
    }
]

Create an anonymous letter.

Request Body schema:
ipedsId
required
string

The IPEDS Id of the school

stateOfResidence
string

The student's state of residence.

applicationDate
string <date-time>

The date on which the application was submitted

object (StudentProfile)

Student profile information.

imageBase64
required
string [ 0 .. 6990508 ] characters

The Base64 encoded binary image data, as a data URI (e.g. data:image/jpeg;base64). Supports PNG and JPEG of sizes up to roughly 5mb before encoding.

source
string [ 0 .. 128 ] characters

An optional string that indicates the source of the letter.

Responses

Request samples

Content type
{
  • "ipedsId": "string",
  • "stateOfResidence": "string",
  • "applicationDate": "2019-08-24T14:15:22Z",
  • "profile": {
    },
  • "imageBase64": "string",
  • "source": "string"
}

Response samples

Content type
{ }

Schools

Get a list of all known schools.

query Parameters
nameSearchFilter
string

An optional name (or partial name) by which to filter the schools.

stateAbbreviation
string

An optional two character US state abbreviation by which to filter the schools.

Responses

Response samples

Content type
[
  • {
    }
]

Get a single school

path Parameters
ipedsid
required
string

The IPEDS Id of the school

Responses

Response samples

Content type
{
  • "ipedsId": "string",
  • "name": "string",
  • "state": "string"
}

Students

Get all students

query Parameters
email
string

An optional email string by which search

Responses

Response samples

Content type
[
  • {
    }
]

Create a new student

Request Body schema:

The student request

firstName
required
string [ 1 .. 50 ] characters

The first name of the student (1-50 characters)

lastName
required
string [ 1 .. 50 ] characters

The last name of the student (1-50 characters)

email
required
string [ 5 .. 100 ] characters

The student's email address (5-100 characters)

required
object (Address)

An address.

object (StudentDemographics)

Student demographic information.

required
object (StudentProfile)

Student profile information.

Responses

Request samples

Content type
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "address": {
    },
  • "demographics": {
    },
  • "profile": {
    }
}

Response samples

Content type
{ }

Get a single student

path Parameters
id
required
string

The unique identifier of the student

Responses

Response samples

Content type
[
  • {
    }
]

Update a student

path Parameters
id
required
string

The unique identifier of the student

Request Body schema:

The update request

object (Address)

An address.

object (StudentDemographics)

Student demographic information.

object (StudentProfile)

Student profile information.

Responses

Request samples

Content type
{
  • "address": {
    },
  • "demographics": {
    },
  • "profile": {
    }
}

Response samples

Content type
{
  • "id": "00000000-0000-0000-0000-000000000000",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "string",
  • "address": {
    },
  • "demographics": {
    },
  • "profile": {
    },
  • "connection": {
    }
}

Get all letters for a student

path Parameters
id
required
string

The unique identifier of the student

Responses

Response samples

Content type
[
  • {
    }
]

Create a letter

path Parameters
id
required
string

The unique identifier of the student.

Request Body schema:

The letter request

ipedsId
required
string

The IPEDS Id of the school

applicationDate
string <date-time>

The date on which the application was submitted

object (LetterCircumstances)

Circumstances under which a letter may have been awarded

object (StudentProfile)

Student profile information.

imageBase64
required
string [ 0 .. 6990508 ] characters

The Base64 encoded binary image data, as a data URI (e.g. data:image/jpeg;base64). Supports PNG and JPEG of sizes up to roughly 5mb before encoding.

Responses

Request samples

Content type
{
  • "ipedsId": "string",
  • "applicationDate": "2019-08-24T14:15:22Z",
  • "circumstances": {
    },
  • "profile": {
    },
  • "imageBase64": "string"
}

Response samples

Content type
{ }

Get a single letter for a student

path Parameters
studentId
required
string

The unique identifier of the student

letterId
required
string

The unique identifier of the letter

Responses

Response samples

Content type
{
  • "id": 0,
  • "submitDate": "2019-08-24T14:15:22Z",
  • "applicationDate": "2019-08-24T14:15:22Z",
  • "status": "Deleted",
  • "circumstances": {
    },
  • "profile": {
    },
  • "price": {
    },
  • "school": {
    }
}

Get the URL for the image associated with a letter

path Parameters
studentId
required
string

The unique identifier of the student.

letterId
required
string

The unique identifier of the letter.

Responses

Response samples

Content type
"string"