v2

api/v2/contact

Contact Report Data

The Accredit contact/getData API for contact data retrieval is built around user reports.

These reports act as customizable templates, allowing you to tailor the response data according to your requirements.

By configuring your user report, you can define which fields are included in the response, ensuring that you receive only the information that is important to you.

While the API offers extensive filtering options and is designed as a robust reporting tool, this flexibility can significantly impact performance. The large database queries required may lead to slow response times and increased system load.

Therefore, it is recommended to avoid frequent calls to this API to maintain optimal performance.

Fetching Contact Details

Using the API is straightforward. Simply make a POST request to the designated endpoint, providing any optional filters you wish to apply. These filters allow you to refine your query, narrowing down the results to precisely what you need.

Dynamic Response

One of the key features of this API is its dynamic response. The data returned is directly influenced by the configuration of your assigned user report. This means that you have full control over the structure and content of the response, ensuring that it aligns perfectly with your requirements.

JSON

{
  "ContactData": [
    {
      "Email Address": "[email protected]",
      "Functional Area": "working group",
      "Forename": "Sparky",
      "Surname": "Grumet",
      "Title": "Mr",
      "QuestionAnswers": [],
      "ContactAdditionalInformation": [],
      "AccessZones": []
    }
  ],
  "HttpStatusCode": 200
}

Should you encounter any difficulties setting up your report or if you're not receiving the expected response, don't hesitate to reach out to your point of contact at Accredit. We're here to ensure that your experience with our API is seamless and productive.

Contact Registration Data

The Accredit GET contact API is a fixed-response, more lightweight, and standardized endpoint.

While it lacks the configurability of the getData report API, it is better suited for operations that require frequent use and/or for which response times are a critical factor.

Error Codes

Code	Value	HttpStatusCode
ACR_02.001.000	User has no Data Permissions for Registration Sub Type	Unauthorized
ACR_02.001.001	User does not have access to Event	BadRequest
ACR_02.001.002	User does not have a report assigned to them	BadRequest
ACR_02.001.003	No Matching Event Found	BadRequest

For a comprehensive overview of potential error codes and their structure, please refer to our documentation .