Members

Retrieve a specific member's consent details

Retrieve more consent information for a specific member based on their key.

get/members/{key}/consent

Request

Base URL
https://api.cyberimpact.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/cyberimpact/apis/cyberimpact-api/docs/members/:key/consent/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

keystring required

Can be either the member's email address or their numerical ID

Response

List of the consent attributes for the specified member

consentTypestring

relationTypestring

consentDatestring nullable

consentExpirationstring nullable

consentProofstring

Example response

{
  "consentType": "implied",
  "relationType": "active-clients",
  "consentDate": "2022-01-01 00:00:00.000",
  "consentExpiration": "2024-01-01 00:00:00.000",
  "consentProof": "Customer since 2015, see invoices"
}

Changes

No recorded changes to this operation across all 1 revision of this API.