Skip to content

Get title

/find_one

Target audience: Developers

Release version: 4.3.10

Get title

Introduction

Returns a single title for an organisation

URI

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

Requirements

Identity Scope
No /external/title/r

Parameters

Name Type Description
title_code String Title code a title.
Size range: 1..15 Allowed values: "/^[a-zA-Z-_0-9]+$/"

Curl Example

Get by title code

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

Response

Successful response

HTTP 200
{
  "item": {
    "name": "Title 1",
    "code": "code1",
    "image_url": "https://cdn_url/Image/adeprimo/title_image_123.png",
    "merchant_image_url": "https://cdn_url/Image/adeprimo/title_image_456.png",
    "url": "https://www.adeprimo.se",
    "rgb": "#00aabb"
  }
}

Errors

This API uses the common error conventions of the Payway API

See common error responses