...

Field	Value type	Description	Example
IDSite	string		Unique identifier of the site.	7090fad1-c4da-4488-9ceb-55ee9847edcc
Site	string	Name of site	Melbourne
Description	string		description of site	This is a description of the site

...

Field	Value type	Example
IDType	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string	Name of type	Phone
Description	string	description of type	Lead generated by phone.

...

Field	Value type	Description	Example
IDType	string		Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string	Name of type	VIP
Description	string		description of type	Very important customer

...

Field	Value type	Description	Example
IDType	string		Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string	Name of type	VIP
Description	string		description of type	Very important customer

...

Field	Value type	Description	Example
IDJobType	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
IDWorkFlow	string		ID of the workflow used for the specific job type.	jdk0fad1-c4da-4488-ereb-55ee9847edcc
Name	string		Name of job	AdHoc
Descr	string		Description of job	AdHoc job used for last minute work
Colour	string		HEX colour used to colour code the job	#hhjkgf

...

Field	Value type	Description	Example
IDType	string		Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
TypeName	string	Name of type	General
Description	string		description of type	General note type

...

Code Block

<?xml version="1.0" encoding="UTF-8"?>
<ArrayOfTypeCrittah xmlns="http://schemas.datacontract.org/2004/07/Spinifex.lib.objects" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <TypeCrittah>
      <IDType>22fcd267-1958-4a27-8e9c-09139ea3f8a8</IDType>
      <TypeName>Delivery</TypeName>
      <Description>Delivery Details</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>77d5d244-eb29-4b5b-8b14-87d92b4215ea</IDType>
      <TypeName>General</TypeName>
      <Description>GeneralNote</Description>
   </TypeCrittah>
   <TypeCrittah>
      <IDType>2b11efc3-2a43-4c03-92ac-923e77f821a2</IDType>
      <TypeName>Important</TypeName>
      <Description>Important Note</Description>
   </TypeCrittah>
</ArrayOfTypeCrittah>

Anchor

...

ClosedReasons

...

ClosedReasons

...

Closed Reasons

Returns a list of all contact statuses closed reasons configured in Crittah.

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/statuses/contactclosedreasons
GET	Returns data defining contact statustypes

Data fields

Field	Value type	Description	Example
IDStatusIDType	string		Unique identifier of the typeclosed reason	7090fad1-c4da-4488-9ceb-55ee9847edcc
StatusNameTypeName	string	Name of statusclosed reasons	ActiveVIP
Description	string		description of status	Acitve

Get contact status

closed reason

Very important customer

Get closed reasons

Sample cURL call:

Code Block

curl -H "Content-Type: application/json"  \
-H "API-AppID: 7090fad1-c4da-4488-9ceb-55ee9847edcc" \
-H "Api-Username: jsmith" \
-H "API-Password: abc123" \
http://[CompanyID].crittah.com/ws/apiv2/json/closedreasons

JSON Rsponse:

Code Block

[
    {
        "IDType": "24501b6f-dbeb-4344-a565-419bd2df26fe",
        "TypeName": "No longer needed",
        "Description": "No longer needed"
    },
 {
        "IDType": "24501b6f-dbeb-4344-a565-419bd2df26fe",
        "TypeName": "customer cancelled",
        "Description": "customer cancelled"
    }
]

Anchor
ContactStatuses
ContactStatuses
Contact Status

Returns a list of all contact statuses configured in Crittah.

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/statuses/contact
GET	Returns data defining contact status

Data fields

Field	Value type	Description	Example
IDStatus	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
StatusName	string	Name of status	Active
Description	string	description of status	Acitve

Get contact status

Sample cURL call:

Code Block

curl -H "Content-Type: application/json"  \
-H "API-AppID: 7090fad1-c4da-4488-9ceb-55ee9847edcc" \
-H "Api-Username: jsmith" \
-H "API-Password: abc123" \
http://[CompanyID].crittah.com/ws/apiv2/json/statuses/contact

...

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/statuses/customer
GET	Returns data defining customer status

Data fields

Field	Value type	Example
IDStatus	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
StatusName	string	Name of status	Active
Description	string	description of status	Acitve

...

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/users
GET	Returns data of all users

Data fields

Field	Value type	Description	Example
IDUser	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
Salutation	string		Salutation of the user	Mr
FirstName	string	First name of the user	John
LastName	string		Last name of the user	Smith

...

Method	Result
URI	https://[CompanyID].crittah.com/ws/apiv2/[json or xml]/statuses/jobtype/[IDJobType]
GET	Returns data defining job statuses

Data fields

Field	Value type	Description	Example
IDJobType	string		Unique ID for the job type. This is required to return the statuses for s specifc job typ	7090fad1-c4da-4488-9ceb-55ee9847edcc
IDStatus	string	Unique identifier of the type	7090fad1-c4da-4488-9ceb-55ee9847edcc
StatusName	string		Salutation of the user	Mr
Description	string	First name of the user	John

...

Versions Compared

Old Version 7

New Version Current

Key

Anchor

ClosedReasons

ClosedReasons

Closed Reasons

Data fields

Get contact status

Get closed reasons

Anchor
ContactStatuses
ContactStatuses
Contact Status

Data fields

Get contact status

Data fields

Data fields

Data fields

Page Comparison

Versions Compared

Old Version 7

New Version Current

Key

Anchor

ClosedReasons

ClosedReasons

Closed Reasons

Data fields

Get contact status

Get closed reasons

AnchorContactStatusesContactStatusesContact Status

Data fields

Get contact status

Data fields

Data fields

Data fields

Anchor
ContactStatuses
ContactStatuses
Contact Status