Get

POST /okapicrm.v1.OkapiCRMService/GetObject

cURL

cURL

curl --request POST \
  --url https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/GetObject \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apiName": "<string>",
  "id": "<string>"
}
'

200

{
  "apiName": "<string>",
  "archived": true,
  "displayNamePlural": "<string>",
  "displayNameSingular": "<string>",
  "fieldDefinitions": [
    {
      "allowedObjectIds": [
        "<string>"
      ],
      "apiName": "<string>",
      "archived": true,
      "displayName": "<string>",
      "enumValues": [
        {
          "apiName": "<string>",
          "displayColor": [
            "ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED",
            "ENUM_VALUE_DISPLAY_COLOR_RED",
            "ENUM_VALUE_DISPLAY_COLOR_ORANGE",
            "ENUM_VALUE_DISPLAY_COLOR_YELLOW",
            "ENUM_VALUE_DISPLAY_COLOR_GREEN",
            "ENUM_VALUE_DISPLAY_COLOR_BLUE",
            "ENUM_VALUE_DISPLAY_COLOR_VIOLET"
          ],
          "displayName": "<string>"
        }
      ],
      "formula": "<string>",
      "id": "<string>",
      "type": [
        "FIELD_DEFINITION_TYPE_UNSPECIFIED",
        "FIELD_DEFINITION_TYPE_BOOLEAN",
        "FIELD_DEFINITION_TYPE_NUMBER",
        "FIELD_DEFINITION_TYPE_STRING",
        "FIELD_DEFINITION_TYPE_TIMESTAMP",
        "FIELD_DEFINITION_TYPE_USER_ID",
        "FIELD_DEFINITION_TYPE_RECORD_ID",
        "FIELD_DEFINITION_TYPE_ENUM"
      ],
      "unique": true
    }
  ],
  "iconDisplayFieldDefinitionApiName": "<string>",
  "id": "<string>",
  "primaryDisplayFieldDefinitionApiName": "<string>",
  "secondaryDisplayFieldDefinitionApiName": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

apiName · string

id · string

Response

200

application/json

apiName · string

archived · boolean

displayNamePlural · string

displayNameSingular · string

fieldDefinitions · FieldDefinition · object[]

Show child attributes

iconDisplayFieldDefinitionApiName · string

id · string

primaryDisplayFieldDefinitionApiName · string

secondaryDisplayFieldDefinitionApiName · string