Contact Schemas
GET /:account/contact_schemas
A Contact Schema holds a collection of Custom Fields. This collection of fields is used to denote values that can be imported onto a Contact record from a 3rd party integration.
Examples
User views contact schema collection
Request
GET /my_account/contact_schemas
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
-H Authorization:"Bearer {token}" \
-X GET /my_account/contact_schemas
Response
Status
200
Response Type
Example Body
{
"@type": "hydra:Collection",
"id": "/my_account/contact_schemas",
"@context": "/contexts/hydra:Collection.jsonld",
"totalItems": 1,
"members": [
{
"@type": "ContactSchema",
"@context": "/contexts/ContactSchema.jsonld",
"id": "/my_account/contact_schemas/bullhorn/candidate",
"slug": "bullhorn/candidate",
"title": "User",
"fields": {
"@type": "hydra:Collection",
"@context": "/contexts/hydra:Collection.jsonld",
"id": "/my_account/contact_schemas/bullhorn/candidate/fields",
"members": [
{
"@type": "ContactField",
"@context": "/contexts/CustomField.jsonld",
"id": "/my_account/contact_schemas/bullhorn/candidate/candidate-id",
"slug": "candidate-id",
"title": "Candidate ID",
"type": "text",
"description": null,
"externalId": true,
"externalLink": false,
"displayOrder": null
},
{
"@type": "ContactField",
"@context": "/contexts/ContactField.jsonld",
"id": "/my_account/contact_schemas/contact/bullhorn/Candidate/link",
"slug": "link",
"title": "Link",
"type": "url",
"description": "Bullhorn Link",
"externalId": false,
"externalLink": true,
"displayOrder": null
},
{
"@type": "ContactField",
"@context": "/contexts/ContactField.jsonld",
"id": "/my_account/contact_schemas/contact/bullhorn/Candidate/last_synced_at",
"slug": "last_synced_at",
"title": "Last Synced At",
"type": "time",
"description": null,
"externalId": false,
"externalLink": false,
"displayOrder": null
},
{
"@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
}
],
"totalItems": 4
}
}
]
}