Retrieves all contact fields for the CMS.
| Method | URL |
|---|---|
GET |
/v2/contact-fields |
| Response format | JSON |
| Paginated? | No |
| Rate Limited? | Yes (more information) |
This API endpoint supports the following request parameters:
| Parameter | Description | Notes |
|---|---|---|
| api_id |
The api_id is given to you with your access credentials.
|
Required |
| data | The URL encoded JSON data string of search parameters. | Required |
| sig | The HMAC signature for this request. | Required |
https://cmsapi.cofeportal.org/v2/contact-fields?api_id={api_id}&data={data}&sig={sig}
For more details, please see the section on request parameters.
The following search parameters can be used as part of the JSON data string:
| Name | Type | Notes |
|---|---|---|
| diocese_id | Integer | Required |
| metadata | Boolean |
If set to true, the response will include metadata
for each field, where available.
|
A JSON object containing none or more CMS contact fields or an error response.
Where responses normally contain objects with fieldname strings, requests with the metadata boolean set in the search parameters will return objects with fieldname strings as property keys and object values containing structured metadata for the field, for example:
"address1_line1": {
"label": "Address 1: Line 1",
"privacy_setting": "address1_line1_privacy_setting",
"type": "string"
},
For fields where metadata is not available, the property value for the key will be null.