Get a colour

GET/colour/{id}

Authorization

AuthorizationAPI key · headerrequired

The Incoming Secret value (<secretId>.<random>), with or without a Bearer prefix.

Path parameters

idstringrequired

Responses

200

OK. A missing id returns 200 with an empty body — check for an id in the response.

idstring

Colour ID (auto-assigned, read-only)

appIdstring

Application ID (auto-assigned, read-only)

namestring

Colour name

descriptionstring

Colour description

colourSidstring

Colour SID (auto-assigned, read-only)

hexstring

Hex colour code

createdAtstring

Creation date (ISO date, auto-assigned, read-only)

401

Authentication failed. All causes return this identical response.

codeinteger

messagestring

typestring

default

Downstream errors pass through verbatim; x-error-source names the failing service.

codeinteger

messagestring

typestring

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

idpath*

Request

curl -X GET 'https://next.amfg.ai/engine-service/public-api/v1/colour/string' \
  -H 'Authorization: YOUR_API_KEY'

const response = await fetch("https://next.amfg.ai/engine-service/public-api/v1/colour/string", {
  method: "GET",
  headers: {
    "Authorization": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "https://next.amfg.ai/engine-service/public-api/v1/colour/string",
    headers={
        "Authorization": "YOUR_API_KEY"
    },
)

Response

{
  "id": "278",
  "appId": "1677",
  "name": "Test color",
  "colourSid": "X-92-COLOUR-95000",
  "description": "",
  "hex": "#fb0101",
  "createdAt": "2020-02-05T16:22:10.729Z"
}

{
  "code": 401,
  "message": "Not Authorized"
}

{
  "code": 0,
  "message": "string",
  "type": "string"
}