Get Contact Details

GET 
/api/accounts/:accountId/contact-details

Get contact details for the account.

Request

Path Parameters

accountId stringrequired

Account ID for the contact channel

Responses

200

Successful operation

application/json

Schema

Schema

email

object

accountId stringrequired

createdAt date-timerequired

modifiedAt date-timerequired

emailAddress stringrequired

phone

object

accountId stringrequired

createdAt date-timerequired

modifiedAt date-timerequired

phoneNumber stringrequired

Example (from schema)

{
  "email": {
    "accountId": "9b7552cf9abab0f2efed72df6b3ce4bc",
    "createdAt": "2025-03-11T02:40:13.490Z",
    "modifiedAt": "2025-03-11T02:40:13.490Z",
    "emailAddress": "joe@joecardholder.com"
  },
  "phone": {
    "accountId": "9b7552cf9abab0f2efed72df6b3ce4bc",
    "createdAt": "2025-03-11T02:40:13.490Z",
    "modifiedAt": "2025-03-11T02:40:13.490Z",
    "phoneNumber": "+1234567890"
  }
}

400

Request fields are invalid

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired

errors

object[]

Array [

message string

path string

The location of the invalid path param, query param or payload attribute.

]

Example (from schema)

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

403

No Authorization to access resource.

application/json

Schema

Schema

statusCode integerrequired
statusName stringrequired
errorCode stringrequired
reason string

Example (from schema)

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}

Loading...