Company logoTrust Center Documentation

Get contact details

Retrieve detailed information about a specific contact including documents, revisions, and access requests

GET
/api/v1/contacts/{id}
AuthorizationBearer <token>

In: header

Path Parameters

idstring

Contact ID

Response Body

fetch("https://app.orbiqhq.com/api/v1/contacts/550e8400-e29b-41d4-a716-446655440000", {  method: "GET"})
{
  "contact": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "email": "john.doe@example.com",
    "first_name": "John",
    "last_name": "Doe",
    "title": "Security Manager",
    "review_status": "to_review",
    "documents": [
      {
        "documents_id": {
          "id": "string",
          "title": "string",
          "description": "string",
          "state": "string",
          "access_level": "string"
        }
      }
    ],
    "access_requests": [
      {
        "id": "string",
        "review_status": "string",
        "date_created": "2019-08-24T14:15:22Z",
        "date_updated": "2019-08-24T14:15:22Z",
        "documents": [
          {}
        ]
      }
    ]
  },
  "documents": [
    {
      "id": "doc-123",
      "title": "SOC 2 Type II Report",
      "description": "Annual security audit report",
      "state": "available",
      "access_level": "restricted",
      "is_shared": true,
      "file": "https://app.orbiqhq.com/assets/doc-123.pdf",
      "category": {
        "id": "string",
        "title": "string"
      }
    }
  ],
  "revisions": [
    {
      "id": "string",
      "delta": {},
      "activity": "string",
      "timestamp": "2019-08-24T14:15:22Z",
      "user": "string"
    }
  ],
  "accessRequests": [
    {
      "id": "string",
      "review_status": "to_review",
      "date_created": "2019-08-24T14:15:22Z",
      "date_updated": "2019-08-24T14:15:22Z",
      "documents": [
        {
          "documents_id": {
            "id": "string",
            "title": "string",
            "description": "string",
            "state": "string",
            "access_level": "string"
          }
        }
      ]
    }
  ]
}
Empty
Empty
Empty
Empty

How is this guide?