Noroff API Documentation

Some of these are authenticated endpoints. You can visit authentication to get an access token.

These endpoints allow you to create, read, update and delete artworks.

These endpoints support pagination and sorting. Read more about these features here.

The Artwork model

Prop	Type	Default
`id`	`string`	-
`title`	`string`	-
`artist`	`string`	-
`year`	`number`	-
`medium`	`string`	-
`description`	`string`	-
`location`	`string`	-
`image`	`object`	-
`created`	`Date`	-
`updated`	`Date`	-
`owner`	`Profile`	-

All artworks

GET/artworks

Retrieve all artworks.

Response

{
  "data": [
    {
      "id": "string",
      "title": "string",
      "artist": "string",
      "year": 0,
      "medium": "string",
      "description": "string",
      "location": "string",
      "image": {
        "url": "string",
        "alt": "string"
      },
      "created": "2025-01-01T12:00:00.000Z",
      "updated": "2025-01-01T12:00:00.000Z",
      "owner": {
        "name": "string",
        "email": "string",
        "bio": "string",
        "avatar": {
          "url": "string",
          "alt": "string"
        },
        "banner": {
          "url": "string",
          "alt": "string"
        }
      }
    },
    {
      "id": "string",
      "title": "string",
      "artist": "string",
      "year": 0,
      "medium": "string",
      "description": "string",
      "location": "string",
      "image": {
        "url": "string",
        "alt": "string"
      },
      "created": "2025-01-01T12:00:00.000Z",
      "updated": "2025-01-01T12:00:00.000Z",
      "owner": {
        "name": "string",
        "email": "string",
        "bio": "string",
        "avatar": {
          "url": "string",
          "alt": "string"
        },
        "banner": {
          "url": "string",
          "alt": "string"
        }
      }
    }
    // ...
  ],
  "meta": {
    "isFirstPage": true,
    "isLastPage": true,
    "currentPage": 1,
    "previousPage": null,
    "nextPage": null,
    "pageCount": 1,
    "totalCount": 2
  }
}

Single artwork

GET/artworks/<id>

Retrieve a single artwork by its id.

Response

{
  "data": {
    "id": "string",
    "title": "string",
    "artist": "string",
    "year": 0,
    "medium": "string",
    "description": "string",
    "location": "string",
    "image": {
      "url": "string",
      "alt": "string"
    },
    "created": "2025-01-01T12:00:00.000Z",
    "updated": "2025-01-01T12:00:00.000Z",
    "owner": {
      "name": "string",
      "email": "string",
      "bio": "string",
      "avatar": {
        "url": "string",
        "alt": "string"
      },
      "banner": {
        "url": "string",
        "alt": "string"
      }
    }
  },
  "meta": {}
}

Please note that the image.url property must be a fully formed URL that links to a live and publicly accessible image. The API will check the provided URL and if it cannot be accessed publicly you will receive a 400 Bad Request error response.

Request

{
  "title": "string",
  "artist": "string",
  "year": 0,
  "medium": "string",
  "description": "string",
  "location": "string",
  "image": {
    "url": "string",
    "alt": "string"
  }
}

Response

{
  "data": {
    "id": "string",
    "title": "string",
    "artist": "string",
    "year": 0,
    "medium": "string",
    "description": "string",
    "location": "string",
    "image": {
      "url": "string",
      "alt": "string"
    },
    "created": "2025-01-01T12:00:00.000Z",
    "updated": "2025-01-01T12:00:00.000Z",
    "owner": {
      "name": "string",
      "email": "string",
      "bio": "string",
      "avatar": {
        "url": "string",
        "alt": "string"
      },
      "banner": {
        "url": "string",
        "alt": "string"
      }
    }
  },
  "meta": {}
}

Update artwork

PUT/artworks/<id>

Update an artwork by its id. This endpoint returns the updated artwork.

Request

// You can update any amount of the properties of the artwork.
{
  "title": "string",
  "description": "string",
  "location": "string",
  "image": {
    "url": "https://example.com/image.jpg",
    "alt": "string"
  }
}

Response

{
  "data": {
    "id": "string",
    "title": "string",
    "artist": "string",
    "year": 0,
    "medium": "string",
    "description": "string",
    "location": "string",
    "image": {
      "url": "string",
      "alt": "string"
    },
    "image": {
      "url": "string",
      "alt": "string"
    },
    "created": "2025-01-01T12:00:00.000Z",
    "updated": "2025-01-01T12:00:00.000Z",
    "owner": {
      "name": "string",
      "email": "string",
      "bio": "string",
      "avatar": {
        "url": "string",
        "alt": "string"
      },
      "banner": {
        "url": "string",
        "alt": "string"
      }
    }
  },
  "meta": {}
}

Delete artwork

DELETE/artworks/<id>

Delete an artwork by its id.

Returns an empty 204 No Content response on success.

Artworks

The Artwork model

All artworks

Single artwork

Create artwork

Update artwork

Delete artwork

On this page