Skip to content

Get titles

/

Target audience: Developers

Release version: 4.3.10

Get title

Introduction

Returns all titles for an organisation

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/titles/
Production https://backend.worldoftulo.com/external/api/v1/titles/

Requirements

Identity Scope
No /external/title/r

Curl Example

Get by title code

curl --request GET \
  --url https://payway-api.stage.adeprimo.se/external/api/v1/titles/ \
  --header 'accept: application/json' \
  --header 'authorization: Bearer token' \

Response

Successful response

HTTP 200
{
  "items": [
    {
      "name": "Title 1",
      "code": "code1",
      "image_url": "https://cdn_url/Image/adeprimo/title_image_123.jpg",
      "merchant_image_url": "https://cdn_url/Image/adeprimo/title_image_456.png",
      "url": "https://www.adeprimo.se",
      "rgb": "#00aabb"
    },
    {
      "name": "Title 2",
      "code": "code2",
      "image_url": null,
      "url": null,
      "rgb": null
    },
    {
      "name": "Title 3",
      "code": "code3",
      "image_url": null,
      "merchant_image_url": "https://cdn_url/Image/adeprimo/title_image_789.png",
      "url": null,
      "rgb": null
    }
  ]
}

Errors

This API uses the common error conventions of the Payway API

See common error responses