Get a catalogue item

GET

/api/v1/items/{externalId}

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://dashboard.azimea.com/api/v1/items/example"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://dashboard.azimea.com/api/v1/items/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.azimea.com/api/v1/items/example \
  --header 'Authorization: Bearer <token>'

Reads one of the items your system sent, by your own id (externalId). Items synced from a connected store are not found here. Needs the items:read permission.

Authorizations

ApiKey

Parameters

Path Parameters

externalId

required

string

Responses

200

The item

application/json

object

isSuccess

boolean

value

One of:

object

object

string format: guid

source

string

storeId

string format: guid

nullable

externalId

string

kind

string

name

string

description

string

nullable

url

string

nullable

imageUrl

string

nullable

price

number format: decimal

nullable

comparePrice

number format: decimal

nullable

currency

string

nullable

inStock

boolean

stockQuantity

integer format: int32

nullable

categories

Array<string>

attributes

object

key

additional properties

active

boolean

createdAt

string format: date-time

updatedAt

string format: date-time

nullable

status

integer format: int32

errors

Array<object>

object

code

string

message

string

params

object

key

additional properties

fieldErrors

object

key

additional properties

Array<object>

object

code

string

message

string

params

object

key

additional properties

Example

{
  "isSuccess": true,
  "value": {
    "id": "01a10900-0000-7000-8000-000000000001",
    "source": "api",
    "storeId": null,
    "externalId": "plan-pro",
    "kind": "plan",
    "name": "Pro plan",
    "description": "Unlimited projects and priority support.",
    "url": "https://example.com/pricing#pro",
    "imageUrl": "https://example.com/img/pro.png",
    "price": 49,
    "comparePrice": 59,
    "currency": "EUR",
    "inStock": true,
    "stockQuantity": null,
    "categories": [
      "plans"
    ],
    "attributes": {
      "billing": "monthly",
      "seats": 5
    },
    "active": true,
    "createdAt": "2026-10-05T09:00:00+00:00",
    "updatedAt": null
  },
  "status": 0,
  "errors": [],
  "fieldErrors": null
}

401

Missing or invalid API key

403

The key lacks the items:read permission