Link Search Menu Expand Document

Updated Fri May 20th 2022, 18:30 UTC

Custom Schemas for Contacts

GET /:account/contact_schemas/:slug

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 a contact schema

Request

GET /my_account/contact_schemas/bullhorn/Candidate
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /my_account/contact_schemas/bullhorn/Candidate
    

Response

Status

200

Response Type

ContactSchema

Example
{
  "@type": "ContactSchema",
  "@context": "/contexts/ContactSchema.jsonld",
  "id": "/my_account/contact_schemas/bullhorn/Candidate",
  "fields": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/my_account/contact_schemas/bullhorn/Candidate/fields",
    "members": [
      {
        "@type": "CustomField",
        "@context": "/contexts/CustomField.jsonld",
        "id": "/my_account/contact_schemas/bullhorn/Candidate/candidate-id",
        "slug": "candidate-id",
        "title": "Candidate ID",
        "type": "text",
        "description": "The ID to find a Candidate in another system",
        "createdAt": "2020-10-15T20:07:20.862Z",
        "inUse": false
      }
    ],
    "totalItems": 1
  }
}

© 2022 TextUs