Noroff API Documentation

These are authenticated endpoints. You can visit authentication to get an access token.

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`	-
`avatar`	`string`	-
`credits`	`integer`	-
`wins`	`Array<string>`	-
`_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`

Example with all optional query parameters

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

All profiles

GET/auction/profiles

Retrieve all profiles.

Response

[
  {
    "name": "string",
    "email": "user@example.com",
    "avatar": "https://url.com/image.jpg",
    "credits": 0,
    "wins": ["string"],
    "_count": {
      "listings": 0
    }
  },
  {
    "name": "string",
    "email": "user@example.com",
    "avatar": "https://url.com/image.jpg",
    "credits": 0,
    "wins": ["string"],
    "_count": {
      "listings": 0
    }
  }
]

Single profile

GET/auction/profiles/<name>

Retrieve a single profile by its id.

Response

{
  "name": "string",
  "email": "user@example.com",
  "avatar": "https://url.com/image.jpg",
  "credits": 0,
  "wins": ["string"],
  "_count": {
    "listings": 0
  }
}

Update profile media

PUT/auction/profiles/<name>/media

Update or set profile avatar image.

Remove the avatar by setting the property to null.

Please note that profile avatar 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 error response.

Request

{
  "avatar": "https://url.com/image.jpg" // Required
}

Request

{
  "name": "string",
  "email": "user@example.com",
  "avatar": "https://url.com/image.jpg",
  "credits": 0,
  "wins": ["string"],
  "_count": {
    "listings": 0
  }
}

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

[
  {
    "id": "string",
    "title": "string",
    "description": "string",
    "media": ["https://url.com/image.jpg"],
    "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": ["https://url.com/image.jpg"],
    "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
    }
  }
  // ...
]

All bids by profile

GET/auction/profiles/<name>/bids

Retrieve all bids made by profile.

Use the _listing flag to include the associated listing's data.

Response

[
  {
    "id": "string",
    "amount": 0,
    "bidderName": "string",
    "created": "2020-01-01T00:00:00.000Z"
  },
  {
    "id": "string",
    "amount": 0,
    "bidderName": "string",
    "created": "2020-01-01T00:00:00.000Z"
  }
  // ...
]

Profiles

The Profile model

Query parameters

All profiles

Single profile

Update profile media

All listings by profile

All bids by profile

On this page