Read (GET) Organization Metadata

Organization metadata provides a summary of every field in the database for an organization record.

To get the organization metadata:

Execute a GET command on the endpoint {{url}}/metadata/organization/. For information about the database records that return, see Metadata.

For example, here is what the request looks like using the cURL command line tool:

curl --request GET \
  --url 'https://{{url}}/metadata/organization/' \
  --header 'authorization: Bearer {{oauth_token}}' \
  --header 'content-type: application/json'

Here is an example of the metadata for an organization:

{
    "Organization": {
        "Keys": "Org",
        "CustomTable": false,
        "TableName": "Organization",
        "GridID": null,
        "Fields": [
            {
                "FieldName": "Org",
                "FieldType": "String",
                "Caption": "Organization",
                "DefaultValue": "",
                "Hidden": false,
                "Required": true,
                "BaseRequired": true,
                "Updateable": true,
                "BaseUpdateable": true,
                "CustomField": false,
                "Searchable": false,
                "MaxLength": 30
            },
            {
                "FieldName": "Name",
                "FieldType": "String",
                "Caption": "Name",
                "DefaultValue": "",
                "Hidden": false,
                "Required": true,
                "BaseRequired": true,
                "Updateable": true,
                "BaseUpdateable": true,
                "CustomField": false,
                "Searchable": false,
                "MaxLength": 100
            },
            {
                "FieldName": "Status",
                "FieldType": "String",
                "Caption": "Status",
                "DefaultValue": "",
                "Hidden": false,
                "Required": false,
                "BaseRequired": false,
                "Updateable": true,
                "BaseUpdateable": true,
                "CustomField": false,
                "Searchable": false,
                "MaxLength": 1
            }
        ],
        "Caption": "Organization"
    }
}