Version 1 (API key)

Authentication

The App Academy API version 1 uses the API Key authorization. You need the x-api-key which you can obtain in this form.

Pagination

Since the App Academy API was built for educational purposes, the following types of pagination were used:

• offset based

• page based

• has more items based

Endpoints

About

Retrieve the logged user

get

Gets information about the logged API user's account

Authorizations

x-api-key

x-api-keystringRequired

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

401

Unauthorized

get

/about

HTTPcURLJavaScriptPython

GET /api/v1/about HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

[
  {
    "name": "John Doe",
    "email": "[email protected]",
    "webhook": "https://hook.eu1.make.com/abcdef123",
    "webhook-watched-items": "create, update",
    "redirect-URI": "https://www.make.com/oauth/cb/app"
  }
]

Movies

Each user is granted access to 6 default records that cannot be updated or deleted.

Each user can create up to 14 records, resulting in a total of 20 retrievable records.

Create a movie

post

Creates a movie.

Authorizations

x-api-key

x-api-keystringRequired

Header parameters

x-api-keystringRequired

API key for authorization.

Body

application/json

namestringRequiredExample: Iron Man

directorIdstringRequiredExample: f841a38b77be

releaseDatestringRequiredExample: 2008

lengthnumberOptionalExample: 126

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

post

/movies

HTTPcURLJavaScriptPython

POST /api/v1/movies HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "name": "Iron Man",
  "genres": [
    {
      "id": "1"
    }
  ],
  "directorId": "f841a38b77be",
  "releaseDate": "2008",
  "length": 126,
  "topCast": [
    {
      "role": "Tony Stark",
      "castId": "5bfb3056c5e4"
    }
  ],
  "boxOffice": {
    "budget": 140,
    "grossProfit": 585.8
  },
  "premieres": {
    "czechPremiere": "2008-04-30T22:00:00+00:00",
    "originalPremiere": "2008-05-01T22:00:00+00:00"
  }
}

{
  "id": "0c841ade9610",
  "name": "Iron Man",
  "genres": [
    {
      "id": "1",
      "name": "action"
    }
  ],
  "length": 126,
  "topCast": [
    {
      "role": "Tony Stark",
      "castId": "5bfb3056c5e4",
      "castName": "Robert Downey Jr."
    }
  ],
  "director": {
    "directorId": "f841a38b77be",
    "directorName": "Jon Favreau"
  },
  "boxOffice": {
    "budget": 140,
    "grossProfit": 585.8
  },
  "createdAt": "2023-04-13T17:04:47+00:00",
  "premieres": {
    "czechPremiere": "2008-04-30T22:00:00+00:00",
    "originalPremiere": "2008-05-01T22:00:00+00:00"
  },
  "updatedAt": "2023-04-19T17:04:47+00:00",
  "releaseDate": "2008"
}

List movies

get

Lists movies.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

pagenumberOptional

The number of the page to retrieve.

sincestringOptional

Retrieve records with dates in the provided sort parameter since this time. Default is createdAt. Allowed format YYYY-MM-DDTHH:mm:ssZ.

orderstring · enumOptional

The order in which the records should be returned. Default is asc.

Possible values:

sortstring · enumOptional

The parameter to be used for ordering the records. Available values are createdAt, updatedAt, name, originalPremiere, czechPremiere.

Possible values:

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

get

/movies

HTTPcURLJavaScriptPython

GET /api/v1/movies HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

{
  "result": [
    {
      "id": "0c841ade9610",
      "name": "Iron Man",
      "genres": [
        {
          "id": "1",
          "name": "action"
        }
      ],
      "length": 126,
      "topCast": [
        {
          "role": "Tony Stark",
          "castId": "5bfb3056c5e4",
          "castName": "Robert Downey Jr."
        }
      ],
      "director": {
        "directorId": "f841a38b77be",
        "directorName": "Jon Favreau"
      },
      "boxOffice": {
        "budget": 140,
        "grossProfit": 585.8
      },
      "createdAt": "2023-04-13T17:04:47+00:00",
      "premieres": {
        "czechPremiere": "2008-04-30T22:00:00+00:00",
        "originalPremiere": "2008-05-01T22:00:00+00:00"
      },
      "updatedAt": "2023-04-19T17:04:47+00:00",
      "releaseDate": "2008"
    }
  ]
}

Retrieve a movie

get

Retrieves a movie.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

ID of the resource to work with.

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

404

Record not found

application/json

get

/movies/{id}

HTTPcURLJavaScriptPython

GET /api/v1/movies/{id} HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

{
  "id": "0c841ade9610",
  "name": "Iron Man",
  "genres": [
    {
      "id": "1",
      "name": "action"
    }
  ],
  "length": 126,
  "topCast": [
    {
      "role": "Tony Stark",
      "castId": "5bfb3056c5e4",
      "castName": "Robert Downey Jr."
    }
  ],
  "director": {
    "directorId": "f841a38b77be",
    "directorName": "Jon Favreau"
  },
  "boxOffice": {
    "budget": 140,
    "grossProfit": 585.8
  },
  "createdAt": "2023-04-13T17:04:47+00:00",
  "premieres": {
    "czechPremiere": "2008-04-30T22:00:00+00:00",
    "originalPremiere": "2008-05-01T22:00:00+00:00"
  },
  "updatedAt": "2023-04-19T17:04:47+00:00",
  "releaseDate": "2008"
}

Update a movie

put

Updates a movie. Without partial update.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

ID of the resource to work with.

Header parameters

x-api-keystringRequired

API key for authorization.

Body

application/json

namestringRequiredExample: Iron Man

directorIdstringRequiredExample: f841a38b77be

releaseDatestringRequiredExample: 2008

lengthnumberOptionalExample: 126

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

404

Record not found

application/json

put

/movies/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/movies/{id} HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "name": "Iron Man",
  "genres": [
    {
      "id": "1"
    }
  ],
  "directorId": "f841a38b77be",
  "releaseDate": "2008",
  "length": 126,
  "topCast": [
    {
      "role": "Tony Stark",
      "castId": "5bfb3056c5e4"
    }
  ],
  "boxOffice": {
    "budget": 140,
    "grossProfit": 585.8
  },
  "premieres": {
    "czechPremiere": "2008-04-30T22:00:00+00:00",
    "originalPremiere": "2008-05-01T22:00:00+00:00"
  }
}

{
  "id": "0c841ade9610",
  "name": "Iron Man",
  "genres": [
    {
      "id": "1",
      "name": "action"
    }
  ],
  "length": 126,
  "topCast": [
    {
      "role": "Tony Stark",
      "castId": "5bfb3056c5e4",
      "castName": "Robert Downey Jr."
    }
  ],
  "director": {
    "directorId": "f841a38b77be",
    "directorName": "Jon Favreau"
  },
  "boxOffice": {
    "budget": 140,
    "grossProfit": 585.8
  },
  "createdAt": "2023-04-13T17:04:47+00:00",
  "premieres": {
    "czechPremiere": "2008-04-30T22:00:00+00:00",
    "originalPremiere": "2008-05-01T22:00:00+00:00"
  },
  "updatedAt": "2023-04-19T17:04:47+00:00",
  "releaseDate": "2008"
}

Update a movie

patch

Updates a movie. With partial update.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

ID of the resource to work with.

Header parameters

x-api-keystringRequired

API key for authorization.

Body

application/json

namestringOptionalExample: Iron Man

directorIdstringOptionalExample: f841a38b77be

releaseDatestringOptionalExample: 2008

lengthnumberOptionalExample: 126

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

404

Record not found

application/json

patch

/movies/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/movies/{id} HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "name": "Iron Man",
  "genres": [
    {
      "id": "1"
    }
  ],
  "directorId": "f841a38b77be",
  "releaseDate": "2008",
  "length": 126,
  "topCast": [
    {
      "role": "Tony Stark",
      "castId": "5bfb3056c5e4"
    }
  ],
  "boxOffice": {
    "budget": 140,
    "grossProfit": 585.8
  },
  "premieres": {
    "czechPremiere": "2008-04-30T22:00:00+00:00",
    "originalPremiere": "2008-05-01T22:00:00+00:00"
  }
}

{
  "id": "0c841ade9610",
  "name": "Iron Man",
  "genres": [
    {
      "id": "1",
      "name": "action"
    }
  ],
  "length": 126,
  "topCast": [
    {
      "role": "Tony Stark",
      "castId": "5bfb3056c5e4",
      "castName": "Robert Downey Jr."
    }
  ],
  "director": {
    "directorId": "f841a38b77be",
    "directorName": "Jon Favreau"
  },
  "boxOffice": {
    "budget": 140,
    "grossProfit": 585.8
  },
  "createdAt": "2023-04-13T17:04:47+00:00",
  "premieres": {
    "czechPremiere": "2008-04-30T22:00:00+00:00",
    "originalPremiere": "2008-05-01T22:00:00+00:00"
  },
  "updatedAt": "2023-04-19T17:04:47+00:00",
  "releaseDate": "2008"
}

Delete a movie

delete

Deletes a movie.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

ID of the resource to work with.

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

401

Unauthorized

delete

/movies/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/movies/{id} HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

{
  "success": "true"
}

People

The query (parameter q ) has to be written in this format:

• all the conditions can be grouped by operator AND

• the value in each condition has to be enclosed in quotation marks

• supported conditions:

  • contains

  • startsWith

  • endsWith

  • equal

• multiple conditions can be used multiple times within one query

example:

contains= "Rob" AND startsWith = "Rob" AND endsWith = "Jr."

Search people involved in movies.

get

Searches people involved in movies.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

qstringOptional

The query to search in records.

Example: contains= \"Rob\" AND startsWith = \"Rob\" AND endsWith = \"Jr.\" AND equals = \"Robert Downey Jr.\"

offsetnumberOptional

The number of records to skip.

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

get

/people

HTTPcURLJavaScriptPython

GET /api/v1/people HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

{
  "result": [
    {
      "id": "5bfb3056c5e4",
      "name": "Robert Downey Jr."
    }
  ]
}

Organizations

List organizations involved in movies.

get

Lists organizations involved in movies.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

pagenumberOptional

The number of the page to retrieve.

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

get

/organizations

HTTPcURLJavaScriptPython

GET /api/v1/organizations HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

{
  "result": [
    {
      "id": "1",
      "awardName": "Oscar",
      "awardCategories": [
        "[\"best-achievement-in-sound-editing\",\"best-achievement-in-visual-effects\"]"
      ],
      "organizationName": "Academy Awards, USA"
    }
  ]
}

Genres

List genres of movies.

get

Lists genres of movies.

Authorizations

x-api-key

x-api-keystringRequired

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

get

/genres

HTTPcURLJavaScriptPython

GET /api/v1/genres HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

{
  "result": [
    {
      "id": "1",
      "name": "action"
    }
  ]
}

Awards

List awards that were obtained by a movie.

get

Lists awards that were obtained by a movie.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

movieIdstringRequired

ID of the movie to work with.

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

get

/awards/{movieId}

HTTPcURLJavaScriptPython

GET /api/v1/awards/{movieId} HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

{
  "hasMoreItems": true,
  "result": [
    {
      "id": "1",
      "award": [
        {
          "people": [
            {
              "id": "5bfb3056c5e4",
              "name": "Robert Downey Jr."
            }
          ],
          "outcome": "0",
          "awardCategoryId": "best-achievement-in-visual-effects"
        }
      ],
      "movieId": "0c841ade9610",
      "organization": {
        "awardName": "Oscar",
        "organizationId": "1",
        "organizationName": "Academy Awards, USA"
      }
    }
  ]
}

Webhooks

Each user can create 1 webhook.

Attach a webhook

post

Attaches a webhook.

Authorizations

x-api-key

x-api-keystringRequired

Header parameters

x-api-keystringRequired

API key for authorization.

Body

application/json

urlstringRequiredExample: https://hook.eu1.make.com/webhookToken

Responses

200

OK

No content

400

Bad request error response

application/json

401

Unauthorized

post

/webhooks

HTTPcURLJavaScriptPython

POST /api/v1/webhooks HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 68

{
  "url": "https://hook.eu1.make.com/webhookToken",
  "events": [
    "create"
  ]
}

No content

Detach a webhook

delete

Detaches a webhook.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

ID of the resource to work with.

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

No content

401

Unauthorized

404

Resource not found.

application/json

delete

/webhooks/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/webhooks/{id} HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

No content

Files

Retrieve a list of files/folders.

get

Retrieves a list of files/folders.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

parentstringOptional

ID of the folder to retrieve its content.

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

get

/files

HTTPcURLJavaScriptPython

GET /api/v1/files HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

200

OK

{
  "items": [
    {
      "name": "exampleFile2.doc",
      "type": "file",
      "mimeType": "image/jpeg",
      "parent": "d6c6bea4f03b",
      "id": "1a0e71b0edb0"
    }
  ],
  "totalPages": 1
}

Download a file.

get

Downloads a file.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

ID of the file to download.

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/octet-stream

Responsestring · binary

get

/files/{id}/export

HTTPcURLJavaScriptPython

GET /api/v1/files/{id}/export HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

200

OK

binary

Upload a file.

post

Upload a file.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

parentstringRequired

ID of the folder where the file should be uploaded.

Header parameters

x-api-keystringRequired

API key for authorization.

Body

application/json

Responses

200

OK

application/json

post

/files/import

HTTPcURLJavaScriptPython

POST /api/v1/files/import?parent=text HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "file": {
    "value": "binary",
    "options": {
      "filename": "myFile.txt"
    }
  }
}

200

OK

{
  "success": "true"
}

Please note that the Import endpoint does not upload or store any data. Therefore, the file

you provide will not be returned or stored in the Files endpoint.

Custom Fields (movie)

List custom fields.

get

Retrieves custom fields.

Authorizations

x-api-key

x-api-keystringRequired

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

get

/custom-fields

HTTPcURLJavaScriptPython

GET /api/v1/custom-fields HTTP/1.1
Host: app-academy.make.com
x-api-key: text
Accept: */*

200

OK

{
  "custom_fields": [
    {
      "name": "review_comment",
      "type": "multi_line_text",
      "label": "Review Comment"
    }
  ]
}

Please note that values in custom fields are not stored in movie records. Therefore, the

values you provide will not be returned or stored in the Movies endpoints.