Version 1 (API key) | Make Developer Hub

Authentication

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

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

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.

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

Organizations

Genres

Awards

Webhooks

Each user can create 1 webhook.

Files

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)

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.

Retrieve a list of files/folders.

get

Retrieves a list of files/folders.

Authorizations

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

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

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

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

200

OK

binary

List custom fields.

get

Retrieves custom fields.

Authorizations

Header parameters

x-api-keystringRequired

API key for authorization.

Responses

200

OK

application/json

get

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

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

Responses

200

OK

application/json

post

POST /api/v1/files/import 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"
}

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

Create a movie

post

Creates a movie.

Authorizations

Header parameters

x-api-keystringRequired

API key for authorization.

Body

namestringRequiredExample: Iron Man

directorIdstringRequiredExample: f841a38b77be

releaseDatestringRequiredExample: 2008

lengthnumberOptionalExample: 126

Responses

200

OK

application/json

400

Bad request error response

application/json

401

Unauthorized

post

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

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

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

Path parameters

idstringRequired

ID of the resource to work with.

Header parameters

x-api-keystringRequired

API key for authorization.

Body

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

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

Path parameters

idstringRequired

ID of the resource to work with.

Header parameters

x-api-keystringRequired

API key for authorization.

Body

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

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

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

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

Attach a webhook

post

Attaches a webhook.

Authorizations

Header parameters

x-api-keystringRequired

API key for authorization.

Body

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

Responses

200

OK

400

Bad request error response

application/json

401

Unauthorized

post

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