/api/v1/accounts/{accountId}/types (GET)

GET

/api/v1/accounts/{accountId}/types

const url = 'https://example.com/api/v1/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/types?includeArchived=0';
const options = {method: 'GET'};

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://example.com/api/v1/accounts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/types?includeArchived=0'

Parameters

Path Parameters

accountId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Query Parameters

includeArchived

string

Allowed values: 0 1 true false

Responses

200

Default Response

application/json

object

types

required

Array<object>

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

parentId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

builtinKey

required

string | null

name

required

string | null

icon

required

string

colour

required

string | null

capabilities

required

Array<string>

Allowed values: container metered warranty serialized consumable expires

resolvedCapabilities

required

Array<string>

Allowed values: container metered warranty serialized consumable expires

isFieldGroup

required

boolean

fieldGroups

required

Array<string>

copiedFromId

required

Any of:

string
null

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

inUse

required

integer

>= -9007199254740991 <= 9007199254740991

rowVersion

required

integer

>= -9007199254740991 <= 9007199254740991

archivedAt

required

string | null

Example

{
  "types": [
    {
      "capabilities": [
        "container"
      ],
      "resolvedCapabilities": [
        "container"
      ]
    }
  ]
}