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

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/about' \
  --header 'x-api-key: text'

200

401

200

[
  {
    "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"
  }
]

OK

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

Header parameters

x-api-keystringrequired

API key for authorization.

Body

namestringrequired

Example: Iron Man

genresobject[]required

directorIdstringrequired

Example: f841a38b77be

releaseDatestringrequired

Example: 2008

lengthnumber

Example: 126

topCastobject[]

boxOfficeobject

premieresobject

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app-academy.make.com/api/v1/movies' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

200

400

401

200

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

OK

List movies

get

Lists movies.

Authorizations

Query parameters

pagenumber

The number of the page to retrieve.

sincestring

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

orderstring · enum

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

Options: asc, desc

sortstring · enum

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

Options: createdAt, updatedAt, name, originalPremiere, czechPremiere

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/movies' \
  --header 'x-api-key: text'

200

400

401

200

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

OK

Retrieve a movie

get

Retrieves a movie.

Authorizations

Path parameters

idstringrequired

ID of the resource to work with.

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/movies/{id}' \
  --header 'x-api-key: text'

200

400

401

404

200

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

OK

Update a movie

put

Updates a movie. Without partial update.

Authorizations

Path parameters

idstringrequired

ID of the resource to work with.

Header parameters

x-api-keystringrequired

API key for authorization.

Body

namestringrequired

Example: Iron Man

genresobject[]required

directorIdstringrequired

Example: f841a38b77be

releaseDatestringrequired

Example: 2008

lengthnumber

Example: 126

topCastobject[]

boxOfficeobject

premieresobject

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://app-academy.make.com/api/v1/movies/{id}' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

200

400

401

404

200

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

OK

Update a movie

patch

Updates a movie. With partial update.

Authorizations

Path parameters

idstringrequired

ID of the resource to work with.

Header parameters

x-api-keystringrequired

API key for authorization.

Body

namestring

Example: Iron Man

genresobject[]

directorIdstring

Example: f841a38b77be

releaseDatestring

Example: 2008

lengthnumber

Example: 126

topCastobject[]

boxOfficeobject

premieresobject

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url 'https://app-academy.make.com/api/v1/movies/{id}' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
    }
  }'

200

400

401

404

200

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

OK

Delete a movie

delete

Deletes a movie.

Authorizations

Path parameters

idstringrequired

ID of the resource to work with.

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app-academy.make.com/api/v1/movies/{id}' \
  --header 'x-api-key: text'

200

401

200

{
  "success": "true"
}

OK

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

Query parameters

qstring

The query to search in records.

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

offsetnumber

The number of records to skip.

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/people' \
  --header 'x-api-key: text'

200

400

401

200

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

OK

Organizations

List organizations involved in movies.

get

Lists organizations involved in movies.

Authorizations

Query parameters

pagenumber

The number of the page to retrieve.

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/organizations' \
  --header 'x-api-key: text'

200

400

401

200

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

OK

Genres

List genres of movies.

get

Lists genres of movies.

Authorizations

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/genres' \
  --header 'x-api-key: text'

200

400

401

200

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

OK

Awards

List awards that were obtained by a movie.

get

Lists awards that were obtained by a movie.

Authorizations

Path parameters

movieIdstringrequired

ID of the movie to work with.

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/awards/{movieId}' \
  --header 'x-api-key: text'

200

400

401

200

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

OK

Webhooks

Each user can create 1 webhook.

Attach a webhook

post

Attaches a webhook.

Authorizations

Header parameters

x-api-keystringrequired

API key for authorization.

Body

urlstringrequired

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

eventsstring · enum[]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app-academy.make.com/api/v1/webhooks' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "url": "https://hook.eu1.make.com/webhookToken",
    "events": [
      "create"
    ]
  }'

200

400

401

200

No body

OK

Detach a webhook

delete

Detaches a webhook.

Authorizations

Path parameters

idstringrequired

ID of the resource to work with.

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://app-academy.make.com/api/v1/webhooks/{id}' \
  --header 'x-api-key: text'

200

401

404

200

No body

OK

Files

Retrieve a list of files/folders.

get

Retrieves a list of files/folders.

Authorizations

Query parameters

parentstring

ID of the folder to retrieve its content.

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/files' \
  --header 'x-api-key: text'

200

200

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

OK

Download a file.

get

Downloads a file.

Authorizations

Path parameters

idstringrequired

ID of the file to download.

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/octet-stream

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/files/{id}/export' \
  --header 'x-api-key: text'

200

200

text

OK

Upload a file.

post

Upload a file.

Authorizations

Query parameters

parentstringrequired

ID of the folder where the file should be uploaded.

Header parameters

x-api-keystringrequired

API key for authorization.

Body

fileobject

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://app-academy.make.com/api/v1/files/import?parent=text' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "file": {
      "value": "text",
      "options": {
        "filename": "myFile.txt"
      }
    }
  }'

200

200

{
  "success": "true"
}

OK

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

Header parameters

x-api-keystringrequired

API key for authorization.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://app-academy.make.com/api/v1/custom-fields' \
  --header 'x-api-key: text'

200

200

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

OK

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.