Skip to main content
GET
/
extended_attributes
/
{extended_attribute_id}
Get an extended model detail
curl --request GET \
  --url http://localhost:3001/portal-api/extended_attributes/{extended_attribute_id} \
  --header 'Authorization: <api-key>'
{
  "ID": 1,
  "ModelName": "User",
  "LastUpdatedBy": "John Smith - john@tyk.io",
  "UpdatedAt": "2023-06-25 13:37",
  "CustomAttributes": [
    {
      "Name": "Terms of use",
      "Identifier": "terms-of-use",
      "Description": "I have read and agreed with...",
      "Behaviour": 3,
      "DropdownValues": "Fleet_management,Cities,EV_management",
      "ValidationRegExp": "www\\.[a-zA-Z0-9]+\\.[a-zA-Z0-9]+",
      "AddToKeyMetadata": true,
      "Required": true,
      "ShowOnSignUp": true,
      "WriteOnceReadMany": true,
      "ID": 1,
      "Type": 2
    }
  ],
  "DefaultAttributes": [
    {
      "AddToKeyMetadata": true,
      "ID": 1,
      "Label": "First Name"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
extended_attribute_id
integer
required

UID of extended attribute

Example:

1

Response

OK

​
ID
integer

UID of this extended attribute

Example:

1

​
ModelName
string

Name of the model for which the custom attributes are extended

Example:

"User"

​
LastUpdatedBy
string

User that made the last update of one of the custom attributes for the extended model

Example:

"John Smith - john@tyk.io"

​
UpdatedAt
string

Timestamp of the last update

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"

​
CustomAttributes
object[]

custom attributes extended for this model

​
DefaultAttributes
object[]

default attributes included for this model