Get
GET /:account/contacts/:contact
Show all known data about a particular Contact
Examples
Get a Contact
Request
GET /contacts/DQeeO69
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X GET /contacts/DQeeO69
Response
Status
200
Response Type
Example Body
{
"id": "/contacts/Vled2N",
"@type": "Contact",
"@context": "/contexts/Contact.jsonld",
"name": "Jamel Hirthe",
"firstName": "Jamel",
"lastName": "Hirthe",
"phones": {
"id": "/contacts/Vled2N/phones",
"@type": "hydra:Collection",
"@context": "/contexts/hydra:Collection.jsonld",
"totalItems": 1,
"members": [
{
"@type": "ContactPhone",
"id": "/contact_phones/mxvbRw",
"@context": "/contexts/ContactPhone.jsonld",
"phoneNumber": "+13035551234",
"formattedPhoneNumber": "(303) 555-1234",
"extension": null,
"type": "Mobile",
"deliverabilityStatus": "unknown",
"contact": "/contacts/DQeeO69"
}
]
},
"notes": {
"@type": "hydra:Collection",
"id": "/contacts/DQeeO69/notes",
"@context": "/contexts/hydra:Collection.jsonld",
"totalItems": 0,
"members": [
{
"@type": "ContactNote",
"id": "/contact_notes/RN5QNG",
"@context": "/contexts/ContactNote.jsonld",
"content": "Life is a fragile thing, Har. One minute you're chewin' on a burger, the next minute you're dead meat.",
"createdAt": "2018-10-31T16:17:10.914Z",
"updatedAt": "2018-10-31T16:17:10.914Z",
"user": {
"@type": "User",
"@context": "/contexts/User.jsonld",
"id": "/users/wqyODPA",
"name": "Chuck Norris",
"firstName": "Chuck",
"lastName": "Norris",
"email": "chuck@textus.example",
"avatar": null,
"automatedActor": false,
"hasPassword": false,
"discarded": false,
"settings": {
"customSettings": {}
},
"memberships": "/users/wqyODPA/memberships"
},
"contact": "/contacts/DQeeO69"
}
]
},
"conversations": "/contacts/DQeeO69/conversations",
"data": {},
"customData": {
"@context": "/contexts/hydra:Collection.jsonld",
"@type": "hydra:Collection",
"id": "/contacts/DQeeO69/custom_data",
"members": [],
"totalItems": 0
},
"createdAt": "2020-01-06T21:49:58.312Z"
}
Get a Contact with Custom Schema data
Request
GET /contacts/DQeeO69
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X GET /contacts/DQeeO69
Response
Status
200
Response Type
Example Body
{
"id": "/contacts/Vled2N",
"@type": "Contact",
"@context": "/contexts/Contact.jsonld",
"name": "Jamel Hirthe",
"firstName": "Jamel",
"lastName": "Hirthe",
"phones": {
"id": "/contacts/Vled2N/phones",
"@type": "hydra:Collection",
"@context": "/contexts/hydra:Collection.jsonld",
"totalItems": 1,
"members": []
},
"notes": {
"@type": "hydra:Collection",
"id": "/contacts/DQeeO69/notes",
"@context": "/contexts/hydra:Collection.jsonld",
"totalItems": 0,
"members": []
},
"conversations": "/contacts/DQeeO69/conversations",
"data": {
"bullhorn": {
"Candidate": {
"id": 100,
"link": "https://bullhorn.example/?Entity=Candidate&id=100",
"name": "Chuck Norris"
}
}
},
"customData": {
"@context": "/contexts/hydra:Collection.jsonld",
"@type": "hydra:Collection",
"id": "/contacts/DQeeO69/custom_data",
"members": [
{
"@type": "ContactData",
"@context": "/contexts/ContactData.jsonld",
"id": "/contacts/DQeeO69/custom_data/bullhorn/Candidate",
"contactSchema": {
"id": "/my-account/contact_schemas/bullhorn/Candidate",
"@type": "CustomSchema",
"@context": "/contexts/CustomSchema.jsonld",
"slug": "bullhorn/Candidate",
"title": "Bullhorn Candidate",
"fields": "/my-account/contact_schemas/bullhorn/Candidate/fields"
},
"data": [
{
"customField": {
"@type": "ContactField",
"@context": "/contexts/ContactField.jsonld",
"id": "/my_account/contact_schemas/contact/bullhorn/Candidate/id",
"slug": "id",
"title": "ID",
"type": "integer",
"description": "Bullhorn ID",
"externalId": true,
"externalLink": false,
"displayOrder": null
},
"value": 100
},
{
"customField": {
"@type": "ContactField",
"@context": "/contexts/ContactField.jsonld",
"id": "/my_account/contact_schemas/contact/bullhorn/Candidate/link",
"slug": "link",
"title": "Link",
"type": "url",
"description": "Bullhorn UI Link",
"externalId": false,
"externalLink": true,
"displayOrder": null
},
"value": "https://bullhorn.example/?Entity=Candidate&id=100"
},
{
"customField": {
"@type": "ContactField",
"@context": "/contexts/ContactField.jsonld",
"id": "/my_account/contact_schemas/contact/bullhorn/Candidate/name",
"slug": "name",
"title": "Name",
"type": "text",
"description": null,
"externalId": false,
"externalLink": false,
"displayOrder": 10
},
"value": "Chuck Norris"
}
]
}
],
"totalItems": 2
},
"createdAt": "2020-01-06T21:49:58.312Z"
}