Skip to main content

ProfileResponse

Registered client profile

idstring
Example: 01HX9QRPBZW4EZG3BTYV7K0M5P
namestring
Example: acme-corp
descriptionstring
Example: ACME Corporation payment pipeline
contactEmailstring
Example: ops@acme.com
statusProfileStatus (string)

Lifecycle status of a profile

Possible values: [ACTIVE, INACTIVE, SUSPENDED]

Example: ACTIVE
specCountinteger
Example: 4
integrationCountinteger
Example: 2
metadata object
property name*string
createdAtstring<date-time>
Example: 2024-03-15T08:00:00Z
updatedAtstring<date-time>
Example: 2024-03-15T09:30:00Z
ProfileResponse
{
  "id": "01HX9QRPBZW4EZG3BTYV7K0M5P",
  "name": "acme-corp",
  "description": "ACME Corporation payment pipeline",
  "contactEmail": "ops@acme.com",
  "status": "ACTIVE",
  "specCount": 4,
  "integrationCount": 2,
  "metadata": {},
  "createdAt": "2024-03-15T08:00:00Z",
  "updatedAt": "2024-03-15T09:30:00Z"
}