Get a specific contact

GET /contacts/{contactId}

This endpoint retrieves a specific request.

The list of requests is limited to 50 results.

Path parameters

contactId string Required

Specify the ID of the contact to retrieve.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- _id string
- email string(email)
- firstName string
- lastName string
- company string
- tag array[string]
- custom array[object]
  
  Hide custom attributes Show custom attributes object
  
  _id string
  
  name string
  
  variable string
  
  value string
- campaignId string
- createdAt string
- status string
- privacy string
- branding object
  
  Hide branding attributes Show branding attributes object
  
  useBranding boolean
  
  brandingId string
- note object
  
  Hide note attributes Show note attributes object
  
  date string
  
  note string
400

Bad Request -- Your request is invalid.
401

Unauthorized -- Your API key is wrong.
403

Forbidden -- The object requested is hidden for administrators only.
404

Not Found -- The specified object could not be found.
429

Too Many Requests -- You're requesting too many objects! Slow down!
500

Internal Server Error -- We had a problem with our server. Try again later.
503

Service Unavailable -- We're temporarily offline for maintenance. Please try again later.

GET /contacts/{contactId}

curl \
 -X GET https://api.usecollect.com/v1/contacts/{contactId}

Response examples (200)

{
  "_id": "uBJadNFcjrC6emRom",
  "tag": [
    "Speaker"
  ],
  "email": "johndoe@example.com",
  "custom": [
    {
      "_id": "yw6XDyeFvbqr86yA6",
      "name": "Favorite color",
      "value": "Blue",
      "variable": "color"
    },
    {
      "_id": "CqdFwGX3yitk9zf8z",
      "name": "Country",
      "value": "US",
      "variable": "country"
    }
  ],
  "lastName": "Doe",
  "requests": [
    {
      "_id": "NxAHPWu9hRzcyD24m",
      "status": "completed",
      "privacy": "team",
      "branding": {
        "useBranding": false
      },
      "createdAt": "2022-02-22T13:40:26Z",
      "campaignId": "mYCsdgB4DQoENBaX6"
    },
    {
      "_id": "jP6sXJ72R8xjxceaP",
      "note": {
        "date": "2022-05-04T14:25:17Z",
        "note": "Asked him to send back another document"
      },
      "status": "completed",
      "privacy": "team",
      "branding": {
        "useBranding": false
      },
      "createdAt": "2022-04-19T13:58:07Z",
      "campaignId": "mYCsdgB4DQoENBaX6"
    },
    {
      "_id": "FmZNnerEFRF3dLYPK",
      "status": "pending",
      "privacy": "team",
      "branding": {
        "brandingId": "jSEj7vHk3wLG3gRF7",
        "useBranding": true
      },
      "createdAt": "2022-06-18T16:19:46Z",
      "campaignId": "mYCsdgB4DQoENBaX6"
    }
  ],
  "createdAt": "2022-02-22T13:40:26Z",
  "firstName": "John",
  "lastActivity": "2022-06-19T17:14:52Z"
}