Organization Metadata
GET {{base_url}}/metadata/organization
Use this endpoint to retrieve organization metadata.
The metadata describes the fields in each table of the database for the record and describes whether or not the table is a custom table and whether or not it has a grid ID. Each field describes whether or not the field is required, the data type, the default value, whether or not it is updateable, and other useful minimums, limits, and maximum details.
For more information, see Metadata Reference.
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | Required. |
The type of content supported by the API endpoint. |
| Authorization | string | | Required.
The type of authorization supported by the API endpoint. |
RESPONSES
status: OK
{"Organization":{"Keys":"Org","CustomTable":false,"TableName":"Organization","GridID":null,"Fields":[{"FieldName":"Org","FieldType":"String","Caption":"Organization","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"MaxLength":30},{"FieldName":"Name","FieldType":"String","Caption":"Name","DefaultValue":"","Hidden":false,"Required":true,"Updateable":true,"CustomField":false,"MaxLength":100},{"FieldName":"Status","FieldType":"String","Caption":"Status","DefaultValue":"","Hidden":false,"Required":false,"Updateable":true,"CustomField":false,"MaxLength":1}],"Caption":"Organization"}}