Noroff API Documentation

These are authenticated endpoints. You can visit authentication to register an account.

These endpoints allow you to manage profiles. They are the users of the auction house and are the owners of listings.

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

The Profile model

Prop	Type	Default
`name`	`string`	-
`email`	`string`	-
`bio`	`string`	-
`banner`	`object`	-
`avatar`	`object`	-
`credits`	`integer`	-
`_count`	`Object`	-

Query parameters

Not all of the properties of a post are returned by default. You can use the following optional query parameters to include additional properties in the response.

Prop	Type	Default
`_listings`	`boolean`	`false`
`_wins`	`boolean`	`false`

Example with all optional query parameters

{
  "data": {
    "name": "string",
    "email": "user@example.com",
    "bio": "string",
    "avatar": {
      "url": "https://url.com/image.jpg",
      "alt": "string"
    },
    "banner": {
      "url": "https://url.com/image.jpg",
      "alt": "string"
    },
    "credits": 0,
    "listings": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "media": [
          {
            "url": "https://url.com/image.jpg",
            "alt": "string"
          }
        ],
        "tags": ["string"],
        "created": "2020-01-01T00:00:00.000Z",
        "updated": "2020-01-01T00:00:00.000Z",
        "endsAt": "2020-01-01T00:00:00.000Z"
      }
    ],
    "wins": [
      {
        "id": "string",
        "title": "string",
        "description": "string",
        "media": [
          {
            "url": "https://url.com/image.jpg",
            "alt": "string"
          }
        ],
        "tags": ["string"],
        "created": "2020-01-01T00:00:00.000Z",
        "updated": "2020-01-01T00:00:00.000Z",
        "endsAt": "2020-01-01T00:00:00.000Z"
      }
    ],
    "_count": {
      "listings": 0,
      "wins": 0
    }
  },
  "meta": {}
}

All profiles

GET/auction/profiles

Retrieve all profiles.

Response

{
  "data": [
    {
      "name": "string",
      "email": "user@example.com",
      "bio": "string",
      "avatar": {
        "url": "https://url.com/image.jpg",
        "alt": "string"
      },
      "banner": {
        "url": "https://url.com/image.jpg",
        "alt": "string"
      },
      "credits": 0,
      "_count": {
        "listings": 0,
        "wins": 0
      }
    },
    {
      "name": "string",
      "email": "user@example.com",
      "bio": "string",
      "avatar": {
        "url": "https://url.com/image.jpg",
        "alt": "string"
      },
      "banner": {
        "url": "https://url.com/image.jpg",
        "alt": "string"
      },
      "credits": 0,
      "_count": {
        "listings": 0,
        "wins": 0
      }
    }
    // ...
  ],
  "meta": {
    "isFirstPage": true,
    "isLastPage": true,
    "currentPage": 1,
    "previousPage": null,
    "nextPage": null,
    "pageCount": 1,
    "totalCount": 2
  }
}

Single profile

GET/auction/profiles/<name>

Retrieve a single profile by its id.

Response

{
  "data": {
    "name": "string",
    "email": "user@example.com",
    "bio": "string",
    "avatar": {
      "url": "https://url.com/image.jpg",
      "alt": "string"
    },
    "banner": {
      "url": "https://url.com/image.jpg",
      "alt": "string"
    },
    "credits": 0,
    "_count": {
      "listings": 0,
      "wins": 0
    }
  },
  "meta": {}
}

Update profile

PUT/auction/profiles/<name>

Update or set bio, banner and avatar properties.

You may provide any combination of the properties, but at least one must be provided.

Please note that the avatar.url and banner.url properties must be fully formed URLs that links to live and publicly accessible images. The API will check the provided URLs and if they cannot be accessed publicly you will receive a 400 Bad Request error response.

Request

{
  "bio": "string",
  "avatar": {
    "url": "https://picsum.photos/id/135/800/800",
    "alt": ""
  },
  "banner": {
    "url": "https://picsum.photos/id/888/1500/500",
    "alt": ""
  }
}

Request

{
  "data": {
    "name": "string",
    "email": "user@example.com",
    "bio": "string",
    "avatar": {
      "url": "https://url.com/image.jpg",
      "alt": "string"
    },
    "banner": {
      "url": "https://url.com/image.jpg",
      "alt": "string"
    },
    "credits": 0,
    "_count": {
      "listings": 0,
      "wins": 0
    }
  },
  "meta": {}
}

All listings by profile

GET/auction/profiles/<name>/listings

Retrieve all listings created by profile.

The response is the same as the listings endpoint, and accepts the same optional query parameters and flags.

Response

{
  "data": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "media": [
        {
          "url": "https://url.com/image.jpg",
          "alt": "string"
        }
      ],
      "tags": ["string"],
      "created": "2020-01-01T00:00:00.000Z",
      "updated": "2020-01-01T00:00:00.000Z",
      "endsAt": "2020-01-01T00:00:00.000Z",
      "_count": {
        "bids": 0
      }
    },
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "media": [
        {
          "url": "https://url.com/image.jpg",
          "alt": "string"
        }
      ],
      "tags": ["string"],
      "created": "2020-01-01T00:00:00.000Z",
      "updated": "2020-01-01T00:00:00.000Z",
      "endsAt": "2020-01-01T00:00:00.000Z",
      "_count": {
        "bids": 0
      }
    }
    // ...
  ],
  "meta": {
    "isFirstPage": true,
    "isLastPage": true,
    "currentPage": 1,
    "previousPage": null,
    "nextPage": null,
    "pageCount": 1,
    "totalCount": 2
  }
}

All bids by profile

GET/auction/profiles/<name>/bids

Retrieve all bids made by profile.

Use the _listings flag to include the associated listing.

Response

{
  "data": [
    {
      "id": "string",
      "amount": 0,
      "bidder": {
        "name": "string",
        "email": "user@example.com",
        "bio": "string",
        "avatar": {
          "url": "https://url.com/image.jpg",
          "alt": "string"
        },
        "banner": {
          "url": "https://url.com/image.jpg",
          "alt": "string"
        }
      },
      "created": "2020-01-01T00:00:00.000Z"
    },
    {
      "id": "string",
      "amount": 0,
      "bidder": {
        "name": "string",
        "email": "user@example.com",
        "bio": "string",
        "avatar": {
          "url": "https://url.com/image.jpg",
          "alt": "string"
        },
        "banner": {
          "url": "https://url.com/image.jpg",
          "alt": "string"
        }
      },
      "created": "2020-01-01T00:00:00.000Z"
    }
    // ...
  ],
  "meta": {
    "isFirstPage": true,
    "isLastPage": true,
    "currentPage": 1,
    "previousPage": null,
    "nextPage": null,
    "pageCount": 1,
    "totalCount": 2
  }
}

All wins by profile

GET/auction/profiles/<name>/wins

Retrieve all listings won by profile.

The response is the same as the listings endpoint, and accepts the same optional query parameters and flags.

Response

{
  "data": [
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "media": [
        {
          "url": "https://url.com/image.jpg",
          "alt": "string"
        }
      ],
      "tags": ["string"],
      "created": "2020-01-01T00:00:00.000Z",
      "updated": "2020-01-01T00:00:00.000Z",
      "endsAt": "2020-01-01T00:00:00.000Z",
      "_count": {
        "bids": 0
      }
    },
    {
      "id": "string",
      "title": "string",
      "description": "string",
      "media": [
        {
          "url": "https://url.com/image.jpg",
          "alt": "string"
        }
      ],
      "tags": ["string"],
      "created": "2020-01-01T00:00:00.000Z",
      "updated": "2020-01-01T00:00:00.000Z",
      "endsAt": "2020-01-01T00:00:00.000Z",
      "_count": {
        "bids": 0
      }
    }
    // ...
  ],
  "meta": {
    "isFirstPage": true,
    "isLastPage": true,
    "currentPage": 1,
    "previousPage": null,
    "nextPage": null,
    "pageCount": 1,
    "totalCount": 2
  }
}

Search profiles

GET/auction/profiles/search?q=<query>

Search for profiles by their name or bio properties.

Profiles

The Profile model

Query parameters

All profiles

Single profile

Update profile

All listings by profile

All bids by profile

All wins by profile

Search profiles

On this page