Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Updated Mon Feb 6th 2023, 19:36 UTC

Show

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 Body

{
  "@type": "ContactSchema",
  "@context": "/contexts/ContactSchema.jsonld",
  "id": "/my_account/contact_schemas/bullhorn/Candidate",
  "slug": "bullhorn/Candidate",
  "title": "Bullhorn Candidate",
  "fields": {
    "@type": "hydra:Collection",
    "@context": "/contexts/hydra:Collection.jsonld",
    "id": "/my_account/contact_schemas/bullhorn/Candidate/fields",
    "members": [
      {
        "@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
      },
      {
        "@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
      },
      {
        "@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": 1
  }
}

© 2023 TextUs