Fetch specific Evaluation Instance

GET /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}

TODO: Resource-level docs

Fetch specific Evaluation Instance.

Path parameters

  • CustomerProfileSid string Required

    The unique string that we created to identify the customer_profile resource.

  • Sid string Required

    The unique string that identifies the Evaluation resource.

Responses

  • OK

    Hide response attributes Show response attributes object
    • account_sid string | null

      The SID of the Account that created the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • The unique string that identifies the resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BU[0-9a-fA-F]{32}$.

    • date_created string(date-time) | null
    • policy_sid string | null

      The unique string of a policy

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RN[0-9a-fA-F]{32}$.

    • results array | null

      The results of the Evaluation resource

    • sid string | null

      The unique string that identifies the Evaluation resource

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^EL[0-9a-fA-F]{32}$.

    • status string | null

      The compliance status of the Evaluation resource

      Values are compliant or noncompliant.

    • url string(uri) | null
GET /v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid}
curl \
 -X GET https://trusthub.twilio.com/v1/CustomerProfiles/{CustomerProfileSid}/Evaluations/{Sid} \
 --user "username:password"
Response examples (200)
{
  "account_sid": "string",
  "customer_profile_sid": "string",
  "date_created": "2023-05-04T09:42:00+00:00",
  "policy_sid": "string",
  "results": [],
  "sid": "string",
  "status": "compliant",
  "url": "https://example.com"
}
Response examples (200)
{
  "account_sid": "string",
  "customer_profile_sid": "string",
  "date_created": "2024-05-04T09:42:00+00:00",
  "policy_sid": "string",
  "results": [],
  "sid": "string",
  "status": "compliant",
  "url": "https://example.com"
}