get https://api.comapi.com/apispaces//profiles?$schemaOnly=true
This method retrieves your API Spaces current schema for your profiles
Use this method to retrieve the schema for your stored profiles. This includes:
- property names
- data types
- example values
- the probability of a value being populated
This method can be useful to help visualise your profile data, or call to look up property names for use with other API calls.
The returned data is an array of the following objects describing the properties that can be found on your API Spaces profiles:
Property Object
| Property | Type | Description |
|---|---|---|
| name | string | The name of the profile property |
| path | string | A dot delimited path into the nested profile data. i.e. facebook.last_name |
| probability | decimal | The probability between 0-1 of the property being populated within your profile data, where 1 is 100% |
| types | type[] | An array of type objects that describe the data types stored under the profile property name. Usually there is a single type |
Type Object
| Property | Type | Description |
|---|---|---|
| name | string | The name of the data type e.g. String |
| probability | decimal | The probability between 0-1 of the property being populated within your profile data, where 1 is 100% |
| examples | any[] | An array of example values of the data type stated in the name property |