Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 13:14 UTC

Custom Schemas for Contacts

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

hydra:Collection

Example
{
  "@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/taleo_v2/candidate",
      "fields": {
        "@type": "hydra:Collection",
        "@context": "/contexts/hydra:Collection.jsonld",
        "id": "/my_account/contact_schemas/taleo_v2/candidate/fields",
        "members": [
          {
            "@type": "CustomField",
            "@context": "/contexts/CustomField.jsonld",
            "id": "/my_account/contact_schemas/taleo_v2/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": 2
      }
    }
  ]
}

© 2021 TextUs