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

Gets information about the logged API user's account

GEThttps://app-academy.make.com/api/v1/about

Authorization

x-api-key

Header parameters

Response

200401

OK

Body

application/json

namestring

emailstring

webhookstring

webhook-watched-itemsstring

redirect-URIstring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/about', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "name": "John Doe",
    "email": "[e-mail]",
    "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

Creates a movie.

POSThttps://app-academy.make.com/api/v1/movies

Authorization

x-api-key

Header parameters

Body

application/json

name*string

genres*array of string

directorId*string

releaseDate*string

lengthnumber

topCastarray of object

boxOfficeobject

premieresobject

Response

200400401

OK

Body

application/json

idstring

namestring

genresarray of object

lengthnumber

topCastarray of object

directorobject

boxOfficeobject

createdAtstring

premieresobject

updatedAtstring

releaseDatestring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/movies', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Iron Man",
      "genres": [
        "1"
      ],
      "releaseDate": "2008",
      "directorId": "f841a38b77be"
    }),
});
const data = await response.json();

Response

{
  "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

Lists movies.

GEThttps://app-academy.make.com/api/v1/movies

Authorization

x-api-key

Query parameters

Header parameters

Response

200400401

OK

Body

application/json

resultResponseMovieArray (array of ResponseMovie (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/movies', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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

Retrieves a movie.

GEThttps://app-academy.make.com/api/v1/movies/{id}

Authorization

x-api-key

Path parameters

id*string

ID of the resource to work with.

Header parameters

Response

200400401404

OK

Body

application/json

idstring

namestring

genresarray of ResponseMovie_genres (object)

lengthnumber

topCastarray of ResponseMovie_topCast (object)

directorResponseMovie_director (object)

boxOfficeResponseMovie_boxOffice (object)

createdAtstring

premieresResponseMovie_premieres (object)

updatedAtstring

releaseDatestring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/movies/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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

Updates a movie. Without partial update.

PUThttps://app-academy.make.com/api/v1/movies/{id}

Authorization

x-api-key

Path parameters

id*string

ID of the resource to work with.

Header parameters

Body

application/json

name*string

genres*array of RequestMovie_genres (object)

directorId*string

releaseDate*string

lengthnumber

topCastarray of RequestMovie_topCast (object)

boxOfficeResponseMovie_boxOffice (object)

premieresResponseMovie_premieres (object)

Response

200400401404

OK

Body

application/json

idstring

namestring

genresarray of ResponseMovie_genres (object)

lengthnumber

topCastarray of ResponseMovie_topCast (object)

directorResponseMovie_director (object)

boxOfficeResponseMovie_boxOffice (object)

createdAtstring

premieresResponseMovie_premieres (object)

updatedAtstring

releaseDatestring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/movies/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "directorId": "f841a38b77be",
      "genres": [
        {}
      ],
      "name": "Iron Man",
      "releaseDate": "2008"
    }),
});
const data = await response.json();

Response

{
  "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

Updates a movie. With partial update.

PATCHhttps://app-academy.make.com/api/v1/movies/{id}

Authorization

x-api-key

Path parameters

id*string

ID of the resource to work with.

Header parameters

Body

application/json

namestring

genresarray of RequestMovie_genres (object)

directorIdstring

releaseDatestring

lengthnumber

topCastarray of RequestMovie_topCast (object)

boxOfficeResponseMovie_boxOffice (object)

premieresResponseMovie_premieres (object)

Response

200400401404

OK

Body

application/json

idstring

namestring

genresarray of ResponseMovie_genres (object)

lengthnumber

topCastarray of ResponseMovie_topCast (object)

directorResponseMovie_director (object)

boxOfficeResponseMovie_boxOffice (object)

createdAtstring

premieresResponseMovie_premieres (object)

updatedAtstring

releaseDatestring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/movies/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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

Deletes a movie.

DELETEhttps://app-academy.make.com/api/v1/movies/{id}

Authorization

x-api-key

Path parameters

id*string

ID of the resource to work with.

Header parameters

Response

200401

OK

Body

application/json

successstring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/movies/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "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." AND equals = "Robert Downey Jr."

Search people involved in movies.

Searches people involved in movies.

GEThttps://app-academy.make.com/api/v1/people

Authorization

x-api-key

Query parameters

Header parameters

Response

200400401

OK

Body

application/json

resultResponsePeopleArray (array of ResponsePeople (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/people', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Organizations

List organizations involved in movies.

Lists organizations involved in movies.

GEThttps://app-academy.make.com/api/v1/organizations

Authorization

x-api-key

Query parameters

Header parameters

Response

200400401

OK

Body

application/json

resultResponseOrganizationsArray (array of ResponseOrganizations (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/organizations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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.

Lists genres of movies.

GEThttps://app-academy.make.com/api/v1/genres

Authorization

x-api-key

Header parameters

Response

200400401

OK

Body

application/json

resultResponseGenresArray (array of ResponseGenres (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/genres', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Awards

List awards that were obtained by a movie.

Lists awards that were obtained by a movie.

GEThttps://app-academy.make.com/api/v1/awards/{movieId}

Authorization

x-api-key

Path parameters

movieId*string

ID of the movie to work with.

Header parameters

Response

200400401

OK

Body

application/json

hasMoreItemsboolean

resultResponseAwardsArray (array of ResponseAwards (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/awards/{movieId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "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

Attaches a webhook.

POSThttps://app-academy.make.com/api/v1/webhooks

Authorization

x-api-key

Header parameters

Body

application/json

url*string

eventsarray of enum

Response

200400401

OK

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/webhooks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "url": "https://hook.eu1.make.com/webhookToken"
    }),
});
const data = await response.json();

Detach a webhook

Detaches a webhook.

DELETEhttps://app-academy.make.com/api/v1/webhooks/{id}

Authorization

x-api-key

Path parameters

id*string

ID of the resource to work with.

Header parameters

Response

200401404

OK

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/webhooks/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

If your detach didn't work for some reason, you can use the About endpoint to retrieve the Webhook ID assigned to your API account.

Files

Retrieve a list of files/folders

Retrieves a list of files/folders.

GEThttps://app-academy.make.com/api/v1/files

Authorization

x-api-key

Query parameters

Header parameters

Response

200401

OK

Body

application/json

itemsResponseFilesArray (array of ResponseFiles (object))

totalPagesnumber

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/files', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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

Download a file

Downloads a file.

GEThttps://app-academy.make.com/api/v1/files/{id}/export

Authorization

x-api-key

Path parameters

id*string

ID of the file to download.

Header parameters

Response

200401404

OK

Headers

Body

application/doc

string (binary)

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/files/{id}/export', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

"string(binary)"

Upload a file.

Uploads a file.

POSThttps://app-academy.make.com/api/v1/files/import

Authorization

x-api-key

Query parameters

Header parameters

Body

multipart/form-data

fileobject

Response

200400404

OK

Body

application/json

successstring

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/files/import', {
    method: 'POST',
    headers: {
      "Content-Type": "multipart/form-data"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "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.

List custom fields.

GEThttps://app-academy.make.com/api/v1/custom-fields

Authorization

x-api-key

Header parameters

Response

200401

OK

Body

application/json

custom_fieldsResponseCustomFieldsArray (array of ResponseCustomFields (object))

Request

JavaScriptCurl

const response = await fetch('https://app-academy.make.com/api/v1/custom-fields', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "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.